Class: Aws::PcaConnectorScep::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-pcaconnectorscep/client.rb

Overview

An API client for PcaConnectorScep. To construct a client, you need to configure a ‘:region` and `:credentials`.

client = Aws::PcaConnectorScep::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See #initialize for a full list of supported configuration options.

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

    • ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

    • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

    • ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

    • ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

    • ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

    • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

    • ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

    When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, `:session_token`, and `:account_id` options.

    • ENV, ENV, ENV, and ENV

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV to true.

  • :region (required, String) —

    The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:

  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to ‘true`, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, ‘default’ is used.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • ‘legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • ‘adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

    • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

  • :validate_params (Boolean) — default: true —

    When ‘true`, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::PcaConnectorScep::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::PcaConnectorScep::EndpointParameters`.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When ‘true`, HTTP debug output will be sent to the `:logger`.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When ‘true`, SSL peer certificates are verified when establishing a connection.



444
445
446
 
# File 'lib/aws-sdk-pcaconnectorscep/client.rb', line 444

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1013
1014
1015
 
# File 'lib/aws-sdk-pcaconnectorscep/client.rb', line 1013

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1016
1017
1018
 
# File 'lib/aws-sdk-pcaconnectorscep/client.rb', line 1016

def errors_module
  Errors
end

Instance Method Details

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • params ({}) (defaults to: {}) 


986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
 
# File 'lib/aws-sdk-pcaconnectorscep/client.rb', line 986

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::PcaConnectorScep')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-pcaconnectorscep'
  context[:gem_version] = '1.11.0'
  Seahorse::Client::Request.new(handlers, context)
end

#create_challenge(params = {}) ⇒ Types::CreateChallengeResponse

For general-purpose connectors. Creates a *challenge password* for the specified connector. The SCEP protocol uses a challenge password to authenticate a request before issuing a certificate from a certificate authority (CA). Your SCEP clients include the challenge password as part of their certificate request to Connector for SCEP. To retrieve the connector Amazon Resource Names (ARNs) for the connectors in your account, call [ListConnectors].

To create additional challenge passwords for the connector, call ‘CreateChallenge` again. We recommend frequently rotating your challenge passwords.

[1]: docs.aws.amazon.com/C4SCEP_API/pca-connector-scep/latest/APIReference/API_ListConnectors.html

Examples:

Request syntax with placeholder values


resp = client.create_challenge({
  connector_arn: "ConnectorArn", # required
  client_token: "ClientToken",
  tags: {
    "String" => "String",
  },
})

Response structure


resp.challenge.arn #=> String
resp.challenge.connector_arn #=> String
resp.challenge.created_at #=> Time
resp.challenge.updated_at #=> Time
resp.challenge.password #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :connector_arn (required, String) —

    The Amazon Resource Name (ARN) of the connector that you want to create a challenge for.

  • :client_token (String) —

    Custom string that can be used to distinguish between calls to the

    CreateChallenge][1

    action. Client tokens for ‘CreateChallenge` time

    out after five minutes. Therefore, if you call ‘CreateChallenge` multiple times with the same client token within five minutes, Connector for SCEP recognizes that you are requesting only one challenge and will only respond with one. If you change the client token for each call, Connector for SCEP recognizes that you are requesting multiple challenge passwords.

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/C4SCEP_API/pca-connector-scep/latest/APIReference/API_CreateChallenge.html

  • :tags (Hash<String,String>) —

    The key-value pairs to associate with the resource.

Returns:

See Also:



516
517
518
519
 
# File 'lib/aws-sdk-pcaconnectorscep/client.rb', line 516

def create_challenge(params = {}, options = {})
  req = build_request(:create_challenge, params)
  req.send_request(options)
end

#create_connector(params = {}) ⇒ Types::CreateConnectorResponse

Creates a SCEP connector. A SCEP connector links Amazon Web Services Private Certificate Authority to your SCEP-compatible devices and mobile device management (MDM) systems. Before you create a connector, you must complete a set of prerequisites, including creation of a private certificate authority (CA) to use with this connector. For more information, see [Connector for SCEP prerequisites].

[1]: docs.aws.amazon.com/privateca/latest/userguide/scep-connector.htmlconnector-for-scep-prerequisites.html

Examples:

Request syntax with placeholder values


resp = client.create_connector({
  certificate_authority_arn: "CertificateAuthorityArn", # required
  mobile_device_management: {
    intune: {
      azure_application_id: "AzureApplicationId", # required
      domain: "AzureDomain", # required
    },
  },
  client_token: "ClientToken",
  tags: {
    "String" => "String",
  },
})

Response structure


resp.connector_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :certificate_authority_arn (required, String) —

    The Amazon Resource Name (ARN) of the Amazon Web Services Private Certificate Authority certificate authority to use with this connector. Due to security vulnerabilities present in the SCEP protocol, we recommend using a private CA that’s dedicated for use with the connector.

    To retrieve the private CAs associated with your account, you can call

    ListCertificateAuthorities][1

    using the Amazon Web Services Private

    CA API.

    [1]: docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html

  • :mobile_device_management (Types::MobileDeviceManagement) —

    If you don’t supply a value, by default Connector for SCEP creates a connector for general-purpose use. A general-purpose connector is designed to work with clients or endpoints that support the SCEP protocol, except Connector for SCEP for Microsoft Intune. With connectors for general-purpose use, you manage SCEP challenge passwords using Connector for SCEP. For information about considerations and limitations with using Connector for SCEP, see [Considerations and Limitations].

    If you provide an ‘IntuneConfiguration`, Connector for SCEP creates a connector for use with Microsoft Intune, and you manage the challenge passwords using Microsoft Intune. For more information, see [Using Connector for SCEP for Microsoft Intune].

    [1]: docs.aws.amazon.com/privateca/latest/userguide/scep-connector.htmlc4scep-considerations-limitations.html [2]: docs.aws.amazon.com/privateca/latest/userguide/scep-connector.htmlconnector-for-scep-intune.html

  • :client_token (String) —

    Custom string that can be used to distinguish between calls to the

    CreateChallenge][1

    action. Client tokens for ‘CreateChallenge` time

    out after five minutes. Therefore, if you call ‘CreateChallenge` multiple times with the same client token within five minutes, Connector for SCEP recognizes that you are requesting only one challenge and will only respond with one. If you change the client token for each call, Connector for SCEP recognizes that you are requesting multiple challenge passwords.

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: docs.aws.amazon.com/C4SCEP_API/pca-connector-scep/latest/APIReference/API_CreateChallenge.html

  • :tags (Hash<String,String>) —

    The key-value pairs to associate with the resource.

Returns:

See Also:



615
616
617
618
 
# File 'lib/aws-sdk-pcaconnectorscep/client.rb', line 615

def create_connector(params = {}, options = {})
  req = build_request(:create_connector, params)
  req.send_request(options)
end

#delete_challenge(params = {}) ⇒ Struct

Deletes the specified [Challenge].

[1]: docs.aws.amazon.com/C4SCEP_API/pca-connector-scep/latest/APIReference/API_Challenge.html

Examples:

Request syntax with placeholder values


resp = client.delete_challenge({
  challenge_arn: "ChallengeArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :challenge_arn (required, String) —

    The Amazon Resource Name (ARN) of the challenge password to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



641
642
643
644
 
# File 'lib/aws-sdk-pcaconnectorscep/client.rb', line 641

def delete_challenge(params = {}, options = {})
  req = build_request(:delete_challenge, params)
  req.send_request(options)
end

#delete_connector(params = {}) ⇒ Struct

Deletes the specified [Connector]. This operation also deletes any challenges associated with the connector.

[1]: docs.aws.amazon.com/C4SCEP_API/pca-connector-scep/latest/APIReference/API_Connector.html

Examples:

Request syntax with placeholder values


resp = client.delete_connector({
  connector_arn: "ConnectorArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :connector_arn (required, String) —

    The Amazon Resource Name (ARN) of the connector to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



668
669
670
671
 
# File 'lib/aws-sdk-pcaconnectorscep/client.rb', line 668

def delete_connector(params = {}, options = {})
  req = build_request(:delete_connector, params)
  req.send_request(options)
end

#get_challenge_metadata(params = {}) ⇒ Types::GetChallengeMetadataResponse

Retrieves the metadata for the specified [Challenge].

[1]: docs.aws.amazon.com/C4SCEP_API/pca-connector-scep/latest/APIReference/API_Challenge.html

Examples:

Request syntax with placeholder values


resp = client.get_challenge_metadata({
  challenge_arn: "ChallengeArn", # required
})

Response structure


resp.challenge_metadata.arn #=> String
resp.challenge_metadata.connector_arn #=> String
resp.challenge_metadata.created_at #=> Time
resp.challenge_metadata.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :challenge_arn (required, String) —

    The Amazon Resource Name (ARN) of the challenge.

Returns:

See Also:



703
704
705
706
 
# File 'lib/aws-sdk-pcaconnectorscep/client.rb', line 703

def get_challenge_metadata(params = {}, options = {})
  req = build_request(:get_challenge_metadata, params)
  req.send_request(options)
end

#get_challenge_password(params = {}) ⇒ Types::GetChallengePasswordResponse

Retrieves the challenge password for the specified [Challenge].

[1]: docs.aws.amazon.com/C4SCEP_API/pca-connector-scep/latest/APIReference/API_Challenge.html

Examples:

Request syntax with placeholder values


resp = client.get_challenge_password({
  challenge_arn: "ChallengeArn", # required
})

Response structure


resp.password #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :challenge_arn (required, String) —

    The Amazon Resource Name (ARN) of the challenge.

Returns:

See Also:



735
736
737
738
 
# File 'lib/aws-sdk-pcaconnectorscep/client.rb', line 735

def get_challenge_password(params = {}, options = {})
  req = build_request(:get_challenge_password, params)
  req.send_request(options)
end

#get_connector(params = {}) ⇒ Types::GetConnectorResponse

Retrieves details about the specified [Connector]. Calling this action returns important details about the connector, such as the public SCEP URL where your clients can request certificates.

[1]: docs.aws.amazon.com/C4SCEP_API/pca-connector-scep/latest/APIReference/API_Connector.html

Examples:

Request syntax with placeholder values


resp = client.get_connector({
  connector_arn: "ConnectorArn", # required
})

Response structure


resp.connector.arn #=> String
resp.connector.certificate_authority_arn #=> String
resp.connector.type #=> String, one of "GENERAL_PURPOSE", "INTUNE"
resp.connector.mobile_device_management.intune.azure_application_id #=> String
resp.connector.mobile_device_management.intune.domain #=> String
resp.connector.open_id_configuration.issuer #=> String
resp.connector.open_id_configuration.subject #=> String
resp.connector.open_id_configuration.audience #=> String
resp.connector.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED"
resp.connector.status_reason #=> String, one of "INTERNAL_FAILURE", "PRIVATECA_ACCESS_DENIED", "PRIVATECA_INVALID_STATE", "PRIVATECA_RESOURCE_NOT_FOUND"
resp.connector.endpoint #=> String
resp.connector.created_at #=> Time
resp.connector.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :connector_arn (required, String) —

    The Amazon Resource Name (ARN) of the connector.

Returns:

See Also:



781
782
783
784
 
# File 'lib/aws-sdk-pcaconnectorscep/client.rb', line 781

def get_connector(params = {}, options = {})
  req = build_request(:get_connector, params)
  req.send_request(options)
end

#list_challenge_metadata(params = {}) ⇒ Types::ListChallengeMetadataResponse

Retrieves the challenge metadata for the specified ARN.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_challenge_metadata({
  max_results: 1,
  next_token: "NextToken",
  connector_arn: "ConnectorArn", # required
})

Response structure


resp.challenges #=> Array
resp.challenges[0].arn #=> String
resp.challenges[0].connector_arn #=> String
resp.challenges[0].created_at #=> Time
resp.challenges[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of objects that you want Connector for SCEP to return for this request. If more objects are available, in the response, Connector for SCEP provides a ‘NextToken` value that you can use in a subsequent call to get the next batch of objects.

  • :next_token (String) —

    When you request a list of objects with a ‘MaxResults` setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Connector for SCEP returns a `NextToken` value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

  • :connector_arn (required, String) —

    The Amazon Resource Name (ARN) of the connector.

Returns:

See Also:



832
833
834
835
 
# File 'lib/aws-sdk-pcaconnectorscep/client.rb', line 832

def list_challenge_metadata(params = {}, options = {})
  req = build_request(:list_challenge_metadata, params)
  req.send_request(options)
end

#list_connectors(params = {}) ⇒ Types::ListConnectorsResponse

Lists the connectors belonging to your Amazon Web Services account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_connectors({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.connectors #=> Array
resp.connectors[0].arn #=> String
resp.connectors[0].certificate_authority_arn #=> String
resp.connectors[0].type #=> String, one of "GENERAL_PURPOSE", "INTUNE"
resp.connectors[0].mobile_device_management.intune.azure_application_id #=> String
resp.connectors[0].mobile_device_management.intune.domain #=> String
resp.connectors[0].open_id_configuration.issuer #=> String
resp.connectors[0].open_id_configuration.subject #=> String
resp.connectors[0].open_id_configuration.audience #=> String
resp.connectors[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED"
resp.connectors[0].status_reason #=> String, one of "INTERNAL_FAILURE", "PRIVATECA_ACCESS_DENIED", "PRIVATECA_INVALID_STATE", "PRIVATECA_RESOURCE_NOT_FOUND"
resp.connectors[0].endpoint #=> String
resp.connectors[0].created_at #=> Time
resp.connectors[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of objects that you want Connector for SCEP to return for this request. If more objects are available, in the response, Connector for SCEP provides a ‘NextToken` value that you can use in a subsequent call to get the next batch of objects.

  • :next_token (String) —

    When you request a list of objects with a ‘MaxResults` setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Connector for SCEP returns a `NextToken` value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

Returns:

See Also:



888
889
890
891
 
# File 'lib/aws-sdk-pcaconnectorscep/client.rb', line 888

def list_connectors(params = {}, options = {})
  req = build_request(:list_connectors, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Retrieves the tags associated with the specified resource. Tags are key-value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to “customer” and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "String", # required
})

Response structure


resp.tags #=> Hash
resp.tags["String"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

Returns:

See Also:



922
923
924
925
 
# File 'lib/aws-sdk-pcaconnectorscep/client.rb', line 922

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Adds one or more tags to your resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "String", # required
  tags: { # required
    "String" => "String",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

  • :tags (required, Hash<String,String>) —

    The key-value pairs to associate with the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



950
951
952
953
 
# File 'lib/aws-sdk-pcaconnectorscep/client.rb', line 950

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes one or more tags from your resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "String", # required
  tag_keys: ["String"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

  • :tag_keys (required, Array<String>) —

    Specifies a list of tag keys that you want to remove from the specified resources.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



977
978
979
980
 
# File 'lib/aws-sdk-pcaconnectorscep/client.rb', line 977

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


1006
1007
1008
 
# File 'lib/aws-sdk-pcaconnectorscep/client.rb', line 1006

def waiter_names
  []
end