Class: Aws::RolesAnywhere::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb

Overview

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

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

For details on configuring region and credentials see the developer guide.

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

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

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 used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or 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[:credentials]

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

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.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['AWS_EC2_METADATA_DISABLED'] 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:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :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.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :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 —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :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_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :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.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :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 https://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:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :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) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or 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::RolesAnywhere::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::RolesAnywhere::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 'http://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.



473
474
475
 
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 473

def initialize(*args)
  super
end

Instance Method Details

#create_profile(params = {}) ⇒ Types::ProfileDetailResponse

Creates a profile, a list of the roles that Roles Anywhere service is trusted to assume. You use profiles to intersect permissions with IAM managed policies.

Required permissions: rolesanywhere:CreateProfile.

Examples:

Request syntax with placeholder values


resp = client.create_profile({
  accept_role_session_name: false,
  duration_seconds: 1,
  enabled: false,
  managed_policy_arns: ["ManagedPolicyListMemberString"],
  name: "ResourceName", # required
  require_instance_properties: false,
  role_arns: ["RoleArn"], # required
  session_policy: "String",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.profile.accept_role_session_name #=> Boolean
resp.profile.attribute_mappings #=> Array
resp.profile.attribute_mappings[0].certificate_field #=> String, one of "x509Subject", "x509Issuer", "x509SAN"
resp.profile.attribute_mappings[0].mapping_rules #=> Array
resp.profile.attribute_mappings[0].mapping_rules[0].specifier #=> String
resp.profile.created_at #=> Time
resp.profile.created_by #=> String
resp.profile.duration_seconds #=> Integer
resp.profile.enabled #=> Boolean
resp.profile.managed_policy_arns #=> Array
resp.profile.managed_policy_arns[0] #=> String
resp.profile.name #=> String
resp.profile.profile_arn #=> String
resp.profile.profile_id #=> String
resp.profile.require_instance_properties #=> Boolean
resp.profile.role_arns #=> Array
resp.profile.role_arns[0] #=> String
resp.profile.session_policy #=> String
resp.profile.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :accept_role_session_name (Boolean) —

    Used to determine if a custom role session name will be accepted in a temporary credential request.

  • :duration_seconds (Integer) —

    Used to determine how long sessions vended using this profile are valid for. See the Expiration section of the CreateSession API documentation page for more details. In requests, if this value is not provided, the default value will be 3600.

  • :enabled (Boolean) —

    Specifies whether the profile is enabled.

  • :managed_policy_arns (Array<String>) —

    A list of managed policy ARNs that apply to the vended session credentials.

  • :name (required, String) —

    The name of the profile.

  • :require_instance_properties (Boolean) —

    Specifies whether instance properties are required in temporary credential requests with this profile.

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

    A list of IAM roles that this profile can assume in a temporary credential request.

  • :session_policy (String) —

    A session policy that applies to the trust boundary of the vended session credentials.

  • :tags (Array<Types::Tag>) —

    The tags to attach to the profile.

Returns:

See Also:



573
574
575
576
 
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 573

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

#create_trust_anchor(params = {}) ⇒ Types::TrustAnchorDetailResponse

Creates a trust anchor to establish trust between IAM Roles Anywhere and your certificate authority (CA). You can define a trust anchor as a reference to an Private Certificate Authority (Private CA) or by uploading a CA certificate. Your Amazon Web Services workloads can authenticate with the trust anchor using certificates issued by the CA in exchange for temporary Amazon Web Services credentials.

Required permissions: rolesanywhere:CreateTrustAnchor.

Examples:

Request syntax with placeholder values


resp = client.create_trust_anchor({
  enabled: false,
  name: "ResourceName", # required
  notification_settings: [
    {
      channel: "ALL", # accepts ALL
      enabled: false, # required
      event: "CA_CERTIFICATE_EXPIRY", # required, accepts CA_CERTIFICATE_EXPIRY, END_ENTITY_CERTIFICATE_EXPIRY
      threshold: 1,
    },
  ],
  source: { # required
    source_data: {
      acm_pca_arn: "String",
      x509_certificate_data: "SourceDataX509CertificateDataString",
    },
    source_type: "AWS_ACM_PCA", # accepts AWS_ACM_PCA, CERTIFICATE_BUNDLE, SELF_SIGNED_REPOSITORY
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.trust_anchor.created_at #=> Time
resp.trust_anchor.enabled #=> Boolean
resp.trust_anchor.name #=> String
resp.trust_anchor.notification_settings #=> Array
resp.trust_anchor.notification_settings[0].channel #=> String, one of "ALL"
resp.trust_anchor.notification_settings[0].configured_by #=> String
resp.trust_anchor.notification_settings[0].enabled #=> Boolean
resp.trust_anchor.notification_settings[0].event #=> String, one of "CA_CERTIFICATE_EXPIRY", "END_ENTITY_CERTIFICATE_EXPIRY"
resp.trust_anchor.notification_settings[0].threshold #=> Integer
resp.trust_anchor.source.source_data.acm_pca_arn #=> String
resp.trust_anchor.source.source_data.x509_certificate_data #=> String
resp.trust_anchor.source.source_type #=> String, one of "AWS_ACM_PCA", "CERTIFICATE_BUNDLE", "SELF_SIGNED_REPOSITORY"
resp.trust_anchor.trust_anchor_arn #=> String
resp.trust_anchor.trust_anchor_id #=> String
resp.trust_anchor.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :enabled (Boolean) —

    Specifies whether the trust anchor is enabled.

  • :name (required, String) —

    The name of the trust anchor.

  • :notification_settings (Array<Types::NotificationSetting>) —

    A list of notification settings to be associated to the trust anchor.

  • :source (required, Types::Source) —

    The trust anchor type and its related certificate data.

  • :tags (Array<Types::Tag>) —

    The tags to attach to the trust anchor.

Returns:

See Also:



656
657
658
659
 
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 656

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

#delete_attribute_mapping(params = {}) ⇒ Types::DeleteAttributeMappingResponse

Delete an entry from the attribute mapping rules enforced by a given profile.

Examples:

Request syntax with placeholder values


resp = client.delete_attribute_mapping({
  certificate_field: "x509Subject", # required, accepts x509Subject, x509Issuer, x509SAN
  profile_id: "Uuid", # required
  specifiers: ["String"],
})

Response structure


resp.profile.accept_role_session_name #=> Boolean
resp.profile.attribute_mappings #=> Array
resp.profile.attribute_mappings[0].certificate_field #=> String, one of "x509Subject", "x509Issuer", "x509SAN"
resp.profile.attribute_mappings[0].mapping_rules #=> Array
resp.profile.attribute_mappings[0].mapping_rules[0].specifier #=> String
resp.profile.created_at #=> Time
resp.profile.created_by #=> String
resp.profile.duration_seconds #=> Integer
resp.profile.enabled #=> Boolean
resp.profile.managed_policy_arns #=> Array
resp.profile.managed_policy_arns[0] #=> String
resp.profile.name #=> String
resp.profile.profile_arn #=> String
resp.profile.profile_id #=> String
resp.profile.require_instance_properties #=> Boolean
resp.profile.role_arns #=> Array
resp.profile.role_arns[0] #=> String
resp.profile.session_policy #=> String
resp.profile.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :certificate_field (required, String) —

    Fields (x509Subject, x509Issuer and x509SAN) within X.509 certificates.

  • :profile_id (required, String) —

    The unique identifier of the profile.

  • :specifiers (Array<String>) —

    A list of specifiers of a certificate field; for example, CN, OU, UID from a Subject.

Returns:

See Also:



713
714
715
716
 
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 713

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

#delete_crl(params = {}) ⇒ Types::CrlDetailResponse

Deletes a certificate revocation list (CRL).

Required permissions: rolesanywhere:DeleteCrl.

Examples:

Request syntax with placeholder values


resp = client.delete_crl({
  crl_id: "Uuid", # required
})

Response structure


resp.crl.created_at #=> Time
resp.crl.crl_arn #=> String
resp.crl.crl_data #=> String
resp.crl.crl_id #=> String
resp.crl.enabled #=> Boolean
resp.crl.name #=> String
resp.crl.trust_anchor_arn #=> String
resp.crl.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :crl_id (required, String) —

    The unique identifier of the certificate revocation list (CRL).

Returns:

See Also:



750
751
752
753
 
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 750

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

#delete_profile(params = {}) ⇒ Types::ProfileDetailResponse

Deletes a profile.

Required permissions: rolesanywhere:DeleteProfile.

Examples:

Request syntax with placeholder values


resp = client.delete_profile({
  profile_id: "Uuid", # required
})

Response structure


resp.profile.accept_role_session_name #=> Boolean
resp.profile.attribute_mappings #=> Array
resp.profile.attribute_mappings[0].certificate_field #=> String, one of "x509Subject", "x509Issuer", "x509SAN"
resp.profile.attribute_mappings[0].mapping_rules #=> Array
resp.profile.attribute_mappings[0].mapping_rules[0].specifier #=> String
resp.profile.created_at #=> Time
resp.profile.created_by #=> String
resp.profile.duration_seconds #=> Integer
resp.profile.enabled #=> Boolean
resp.profile.managed_policy_arns #=> Array
resp.profile.managed_policy_arns[0] #=> String
resp.profile.name #=> String
resp.profile.profile_arn #=> String
resp.profile.profile_id #=> String
resp.profile.require_instance_properties #=> Boolean
resp.profile.role_arns #=> Array
resp.profile.role_arns[0] #=> String
resp.profile.session_policy #=> String
resp.profile.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :profile_id (required, String) —

    The unique identifier of the profile.

Returns:

See Also:



798
799
800
801
 
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 798

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

#delete_trust_anchor(params = {}) ⇒ Types::TrustAnchorDetailResponse

Deletes a trust anchor.

Required permissions: rolesanywhere:DeleteTrustAnchor.

Examples:

Request syntax with placeholder values


resp = client.delete_trust_anchor({
  trust_anchor_id: "Uuid", # required
})

Response structure


resp.trust_anchor.created_at #=> Time
resp.trust_anchor.enabled #=> Boolean
resp.trust_anchor.name #=> String
resp.trust_anchor.notification_settings #=> Array
resp.trust_anchor.notification_settings[0].channel #=> String, one of "ALL"
resp.trust_anchor.notification_settings[0].configured_by #=> String
resp.trust_anchor.notification_settings[0].enabled #=> Boolean
resp.trust_anchor.notification_settings[0].event #=> String, one of "CA_CERTIFICATE_EXPIRY", "END_ENTITY_CERTIFICATE_EXPIRY"
resp.trust_anchor.notification_settings[0].threshold #=> Integer
resp.trust_anchor.source.source_data.acm_pca_arn #=> String
resp.trust_anchor.source.source_data.x509_certificate_data #=> String
resp.trust_anchor.source.source_type #=> String, one of "AWS_ACM_PCA", "CERTIFICATE_BUNDLE", "SELF_SIGNED_REPOSITORY"
resp.trust_anchor.trust_anchor_arn #=> String
resp.trust_anchor.trust_anchor_id #=> String
resp.trust_anchor.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :trust_anchor_id (required, String) —

    The unique identifier of the trust anchor.

Returns:

See Also:



842
843
844
845
 
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 842

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

#disable_crl(params = {}) ⇒ Types::CrlDetailResponse

Disables a certificate revocation list (CRL).

Required permissions: rolesanywhere:DisableCrl.

Examples:

Request syntax with placeholder values


resp = client.disable_crl({
  crl_id: "Uuid", # required
})

Response structure


resp.crl.created_at #=> Time
resp.crl.crl_arn #=> String
resp.crl.crl_data #=> String
resp.crl.crl_id #=> String
resp.crl.enabled #=> Boolean
resp.crl.name #=> String
resp.crl.trust_anchor_arn #=> String
resp.crl.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :crl_id (required, String) —

    The unique identifier of the certificate revocation list (CRL).

Returns:

See Also:



879
880
881
882
 
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 879

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

#disable_profile(params = {}) ⇒ Types::ProfileDetailResponse

Disables a profile. When disabled, temporary credential requests with this profile fail.

Required permissions: rolesanywhere:DisableProfile.

Examples:

Request syntax with placeholder values


resp = client.disable_profile({
  profile_id: "Uuid", # required
})

Response structure


resp.profile.accept_role_session_name #=> Boolean
resp.profile.attribute_mappings #=> Array
resp.profile.attribute_mappings[0].certificate_field #=> String, one of "x509Subject", "x509Issuer", "x509SAN"
resp.profile.attribute_mappings[0].mapping_rules #=> Array
resp.profile.attribute_mappings[0].mapping_rules[0].specifier #=> String
resp.profile.created_at #=> Time
resp.profile.created_by #=> String
resp.profile.duration_seconds #=> Integer
resp.profile.enabled #=> Boolean
resp.profile.managed_policy_arns #=> Array
resp.profile.managed_policy_arns[0] #=> String
resp.profile.name #=> String
resp.profile.profile_arn #=> String
resp.profile.profile_id #=> String
resp.profile.require_instance_properties #=> Boolean
resp.profile.role_arns #=> Array
resp.profile.role_arns[0] #=> String
resp.profile.session_policy #=> String
resp.profile.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :profile_id (required, String) —

    The unique identifier of the profile.

Returns:

See Also:



928
929
930
931
 
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 928

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

#disable_trust_anchor(params = {}) ⇒ Types::TrustAnchorDetailResponse

Disables a trust anchor. When disabled, temporary credential requests specifying this trust anchor are unauthorized.

Required permissions: rolesanywhere:DisableTrustAnchor.

Examples:

Request syntax with placeholder values


resp = client.disable_trust_anchor({
  trust_anchor_id: "Uuid", # required
})

Response structure


resp.trust_anchor.created_at #=> Time
resp.trust_anchor.enabled #=> Boolean
resp.trust_anchor.name #=> String
resp.trust_anchor.notification_settings #=> Array
resp.trust_anchor.notification_settings[0].channel #=> String, one of "ALL"
resp.trust_anchor.notification_settings[0].configured_by #=> String
resp.trust_anchor.notification_settings[0].enabled #=> Boolean
resp.trust_anchor.notification_settings[0].event #=> String, one of "CA_CERTIFICATE_EXPIRY", "END_ENTITY_CERTIFICATE_EXPIRY"
resp.trust_anchor.notification_settings[0].threshold #=> Integer
resp.trust_anchor.source.source_data.acm_pca_arn #=> String
resp.trust_anchor.source.source_data.x509_certificate_data #=> String
resp.trust_anchor.source.source_type #=> String, one of "AWS_ACM_PCA", "CERTIFICATE_BUNDLE", "SELF_SIGNED_REPOSITORY"
resp.trust_anchor.trust_anchor_arn #=> String
resp.trust_anchor.trust_anchor_id #=> String
resp.trust_anchor.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :trust_anchor_id (required, String) —

    The unique identifier of the trust anchor.

Returns:

See Also:



973
974
975
976
 
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 973

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

#enable_crl(params = {}) ⇒ Types::CrlDetailResponse

Enables a certificate revocation list (CRL). When enabled, certificates stored in the CRL are unauthorized to receive session credentials.

Required permissions: rolesanywhere:EnableCrl.

Examples:

Request syntax with placeholder values


resp = client.enable_crl({
  crl_id: "Uuid", # required
})

Response structure


resp.crl.created_at #=> Time
resp.crl.crl_arn #=> String
resp.crl.crl_data #=> String
resp.crl.crl_id #=> String
resp.crl.enabled #=> Boolean
resp.crl.name #=> String
resp.crl.trust_anchor_arn #=> String
resp.crl.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :crl_id (required, String) —

    The unique identifier of the certificate revocation list (CRL).

Returns:

See Also:



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

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

#enable_profile(params = {}) ⇒ Types::ProfileDetailResponse

Enables temporary credential requests for a profile.

Required permissions: rolesanywhere:EnableProfile.

Examples:

Request syntax with placeholder values


resp = client.enable_profile({
  profile_id: "Uuid", # required
})

Response structure


resp.profile.accept_role_session_name #=> Boolean
resp.profile.attribute_mappings #=> Array
resp.profile.attribute_mappings[0].certificate_field #=> String, one of "x509Subject", "x509Issuer", "x509SAN"
resp.profile.attribute_mappings[0].mapping_rules #=> Array
resp.profile.attribute_mappings[0].mapping_rules[0].specifier #=> String
resp.profile.created_at #=> Time
resp.profile.created_by #=> String
resp.profile.duration_seconds #=> Integer
resp.profile.enabled #=> Boolean
resp.profile.managed_policy_arns #=> Array
resp.profile.managed_policy_arns[0] #=> String
resp.profile.name #=> String
resp.profile.profile_arn #=> String
resp.profile.profile_id #=> String
resp.profile.require_instance_properties #=> Boolean
resp.profile.role_arns #=> Array
resp.profile.role_arns[0] #=> String
resp.profile.session_policy #=> String
resp.profile.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :profile_id (required, String) —

    The unique identifier of the profile.

Returns:

See Also:



1060
1061
1062
1063
 
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1060

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

#enable_trust_anchor(params = {}) ⇒ Types::TrustAnchorDetailResponse

Enables a trust anchor. When enabled, certificates in the trust anchor chain are authorized for trust validation.

Required permissions: rolesanywhere:EnableTrustAnchor.

Examples:

Request syntax with placeholder values


resp = client.enable_trust_anchor({
  trust_anchor_id: "Uuid", # required
})

Response structure


resp.trust_anchor.created_at #=> Time
resp.trust_anchor.enabled #=> Boolean
resp.trust_anchor.name #=> String
resp.trust_anchor.notification_settings #=> Array
resp.trust_anchor.notification_settings[0].channel #=> String, one of "ALL"
resp.trust_anchor.notification_settings[0].configured_by #=> String
resp.trust_anchor.notification_settings[0].enabled #=> Boolean
resp.trust_anchor.notification_settings[0].event #=> String, one of "CA_CERTIFICATE_EXPIRY", "END_ENTITY_CERTIFICATE_EXPIRY"
resp.trust_anchor.notification_settings[0].threshold #=> Integer
resp.trust_anchor.source.source_data.acm_pca_arn #=> String
resp.trust_anchor.source.source_data.x509_certificate_data #=> String
resp.trust_anchor.source.source_type #=> String, one of "AWS_ACM_PCA", "CERTIFICATE_BUNDLE", "SELF_SIGNED_REPOSITORY"
resp.trust_anchor.trust_anchor_arn #=> String
resp.trust_anchor.trust_anchor_id #=> String
resp.trust_anchor.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :trust_anchor_id (required, String) —

    The unique identifier of the trust anchor.

Returns:

See Also:



1105
1106
1107
1108
 
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1105

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

#get_crl(params = {}) ⇒ Types::CrlDetailResponse

Gets a certificate revocation list (CRL).

Required permissions: rolesanywhere:GetCrl.

Examples:

Request syntax with placeholder values


resp = client.get_crl({
  crl_id: "Uuid", # required
})

Response structure


resp.crl.created_at #=> Time
resp.crl.crl_arn #=> String
resp.crl.crl_data #=> String
resp.crl.crl_id #=> String
resp.crl.enabled #=> Boolean
resp.crl.name #=> String
resp.crl.trust_anchor_arn #=> String
resp.crl.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :crl_id (required, String) —

    The unique identifier of the certificate revocation list (CRL).

Returns:

See Also:



1142
1143
1144
1145
 
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1142

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

#get_profile(params = {}) ⇒ Types::ProfileDetailResponse

Gets a profile.

Required permissions: rolesanywhere:GetProfile.

Examples:

Request syntax with placeholder values


resp = client.get_profile({
  profile_id: "Uuid", # required
})

Response structure


resp.profile.accept_role_session_name #=> Boolean
resp.profile.attribute_mappings #=> Array
resp.profile.attribute_mappings[0].certificate_field #=> String, one of "x509Subject", "x509Issuer", "x509SAN"
resp.profile.attribute_mappings[0].mapping_rules #=> Array
resp.profile.attribute_mappings[0].mapping_rules[0].specifier #=> String
resp.profile.created_at #=> Time
resp.profile.created_by #=> String
resp.profile.duration_seconds #=> Integer
resp.profile.enabled #=> Boolean
resp.profile.managed_policy_arns #=> Array
resp.profile.managed_policy_arns[0] #=> String
resp.profile.name #=> String
resp.profile.profile_arn #=> String
resp.profile.profile_id #=> String
resp.profile.require_instance_properties #=> Boolean
resp.profile.role_arns #=> Array
resp.profile.role_arns[0] #=> String
resp.profile.session_policy #=> String
resp.profile.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :profile_id (required, String) —

    The unique identifier of the profile.

Returns:

See Also:



1190
1191
1192
1193
 
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1190

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

#get_subject(params = {}) ⇒ Types::SubjectDetailResponse

Gets a subject, which associates a certificate identity with authentication attempts. The subject stores auditing information such as the status of the last authentication attempt, the certificate data used in the attempt, and the last time the associated identity attempted authentication.

Required permissions: rolesanywhere:GetSubject.

Examples:

Request syntax with placeholder values


resp = client.get_subject({
  subject_id: "Uuid", # required
})

Response structure


resp.subject.created_at #=> Time
resp.subject.credentials #=> Array
resp.subject.credentials[0].enabled #=> Boolean
resp.subject.credentials[0].failed #=> Boolean
resp.subject.credentials[0].issuer #=> String
resp.subject.credentials[0].seen_at #=> Time
resp.subject.credentials[0].serial_number #=> String
resp.subject.credentials[0].x509_certificate_data #=> String
resp.subject.enabled #=> Boolean
resp.subject.instance_properties #=> Array
resp.subject.instance_properties[0].failed #=> Boolean
resp.subject.instance_properties[0].properties #=> Hash
resp.subject.instance_properties[0].properties["InstancePropertyMapKeyString"] #=> String
resp.subject.instance_properties[0].seen_at #=> Time
resp.subject.last_seen_at #=> Time
resp.subject.subject_arn #=> String
resp.subject.subject_id #=> String
resp.subject.updated_at #=> Time
resp.subject.x509_subject #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :subject_id (required, String) —

    The unique identifier of the subject.

Returns:

See Also:



1242
1243
1244
1245
 
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1242

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

#get_trust_anchor(params = {}) ⇒ Types::TrustAnchorDetailResponse

Gets a trust anchor.

Required permissions: rolesanywhere:GetTrustAnchor.

Examples:

Request syntax with placeholder values


resp = client.get_trust_anchor({
  trust_anchor_id: "Uuid", # required
})

Response structure


resp.trust_anchor.created_at #=> Time
resp.trust_anchor.enabled #=> Boolean
resp.trust_anchor.name #=> String
resp.trust_anchor.notification_settings #=> Array
resp.trust_anchor.notification_settings[0].channel #=> String, one of "ALL"
resp.trust_anchor.notification_settings[0].configured_by #=> String
resp.trust_anchor.notification_settings[0].enabled #=> Boolean
resp.trust_anchor.notification_settings[0].event #=> String, one of "CA_CERTIFICATE_EXPIRY", "END_ENTITY_CERTIFICATE_EXPIRY"
resp.trust_anchor.notification_settings[0].threshold #=> Integer
resp.trust_anchor.source.source_data.acm_pca_arn #=> String
resp.trust_anchor.source.source_data.x509_certificate_data #=> String
resp.trust_anchor.source.source_type #=> String, one of "AWS_ACM_PCA", "CERTIFICATE_BUNDLE", "SELF_SIGNED_REPOSITORY"
resp.trust_anchor.trust_anchor_arn #=> String
resp.trust_anchor.trust_anchor_id #=> String
resp.trust_anchor.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :trust_anchor_id (required, String) —

    The unique identifier of the trust anchor.

Returns:

See Also:



1286
1287
1288
1289
 
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1286

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

#import_crl(params = {}) ⇒ Types::CrlDetailResponse

Imports the certificate revocation list (CRL). A CRL is a list of certificates that have been revoked by the issuing certificate Authority (CA).In order to be properly imported, a CRL must be in PEM format. IAM Roles Anywhere validates against the CRL before issuing credentials.

Required permissions: rolesanywhere:ImportCrl.

Examples:

Request syntax with placeholder values


resp = client.import_crl({
  crl_data: "data", # required
  enabled: false,
  name: "ResourceName", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  trust_anchor_arn: "TrustAnchorArn", # required
})

Response structure


resp.crl.created_at #=> Time
resp.crl.crl_arn #=> String
resp.crl.crl_data #=> String
resp.crl.crl_id #=> String
resp.crl.enabled #=> Boolean
resp.crl.name #=> String
resp.crl.trust_anchor_arn #=> String
resp.crl.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :crl_data (required, String, StringIO, File) —

    The x509 v3 specified certificate revocation list (CRL).

  • :enabled (Boolean) —

    Specifies whether the certificate revocation list (CRL) is enabled.

  • :name (required, String) —

    The name of the certificate revocation list (CRL).

  • :tags (Array<Types::Tag>) —

    A list of tags to attach to the certificate revocation list (CRL).

  • :trust_anchor_arn (required, String) —

    The ARN of the TrustAnchor the certificate revocation list (CRL) will provide revocation for.

Returns:

See Also:



1349
1350
1351
1352
 
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1349

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

#list_crls(params = {}) ⇒ Types::ListCrlsResponse

Lists all certificate revocation lists (CRL) in the authenticated account and Amazon Web Services Region.

Required permissions: rolesanywhere:ListCrls.

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_crls({
  next_token: "ListRequestNextTokenString",
  page_size: 1,
})

Response structure


resp.crls #=> Array
resp.crls[0].created_at #=> Time
resp.crls[0].crl_arn #=> String
resp.crls[0].crl_data #=> String
resp.crls[0].crl_id #=> String
resp.crls[0].enabled #=> Boolean
resp.crls[0].name #=> String
resp.crls[0].trust_anchor_arn #=> String
resp.crls[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    A token that indicates where the output should continue from, if a previous request did not show all results. To get the next results, make the request again with this value.

  • :page_size (Integer) —

    The number of resources in the paginated list.

Returns:

See Also:



1398
1399
1400
1401
 
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1398

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

#list_profiles(params = {}) ⇒ Types::ListProfilesResponse

Lists all profiles in the authenticated account and Amazon Web Services Region.

Required permissions: rolesanywhere:ListProfiles.

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_profiles({
  next_token: "ListRequestNextTokenString",
  page_size: 1,
})

Response structure


resp.next_token #=> String
resp.profiles #=> Array
resp.profiles[0].accept_role_session_name #=> Boolean
resp.profiles[0].attribute_mappings #=> Array
resp.profiles[0].attribute_mappings[0].certificate_field #=> String, one of "x509Subject", "x509Issuer", "x509SAN"
resp.profiles[0].attribute_mappings[0].mapping_rules #=> Array
resp.profiles[0].attribute_mappings[0].mapping_rules[0].specifier #=> String
resp.profiles[0].created_at #=> Time
resp.profiles[0].created_by #=> String
resp.profiles[0].duration_seconds #=> Integer
resp.profiles[0].enabled #=> Boolean
resp.profiles[0].managed_policy_arns #=> Array
resp.profiles[0].managed_policy_arns[0] #=> String
resp.profiles[0].name #=> String
resp.profiles[0].profile_arn #=> String
resp.profiles[0].profile_id #=> String
resp.profiles[0].require_instance_properties #=> Boolean
resp.profiles[0].role_arns #=> Array
resp.profiles[0].role_arns[0] #=> String
resp.profiles[0].session_policy #=> String
resp.profiles[0].updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    A token that indicates where the output should continue from, if a previous request did not show all results. To get the next results, make the request again with this value.

  • :page_size (Integer) —

    The number of resources in the paginated list.

Returns:

See Also:



1458
1459
1460
1461
 
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1458

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

#list_subjects(params = {}) ⇒ Types::ListSubjectsResponse

Lists the subjects in the authenticated account and Amazon Web Services Region.

Required permissions: rolesanywhere:ListSubjects.

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_subjects({
  next_token: "ListRequestNextTokenString",
  page_size: 1,
})

Response structure


resp.next_token #=> String
resp.subjects #=> Array
resp.subjects[0].created_at #=> Time
resp.subjects[0].enabled #=> Boolean
resp.subjects[0].last_seen_at #=> Time
resp.subjects[0].subject_arn #=> String
resp.subjects[0].subject_id #=> String
resp.subjects[0].updated_at #=> Time
resp.subjects[0].x509_subject #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    A token that indicates where the output should continue from, if a previous request did not show all results. To get the next results, make the request again with this value.

  • :page_size (Integer) —

    The number of resources in the paginated list.

Returns:

See Also:



1506
1507
1508
1509
 
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1506

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

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

Lists the tags attached to the resource.

Required permissions: rolesanywhere:ListTagsForResource.

Examples:

Request syntax with placeholder values


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

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource.

Returns:

See Also:



1538
1539
1540
1541
 
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1538

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

#list_trust_anchors(params = {}) ⇒ Types::ListTrustAnchorsResponse

Lists the trust anchors in the authenticated account and Amazon Web Services Region.

Required permissions: rolesanywhere:ListTrustAnchors.

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_trust_anchors({
  next_token: "ListRequestNextTokenString",
  page_size: 1,
})

Response structure


resp.next_token #=> String
resp.trust_anchors #=> Array
resp.trust_anchors[0].created_at #=> Time
resp.trust_anchors[0].enabled #=> Boolean
resp.trust_anchors[0].name #=> String
resp.trust_anchors[0].notification_settings #=> Array
resp.trust_anchors[0].notification_settings[0].channel #=> String, one of "ALL"
resp.trust_anchors[0].notification_settings[0].configured_by #=> String
resp.trust_anchors[0].notification_settings[0].enabled #=> Boolean
resp.trust_anchors[0].notification_settings[0].event #=> String, one of "CA_CERTIFICATE_EXPIRY", "END_ENTITY_CERTIFICATE_EXPIRY"
resp.trust_anchors[0].notification_settings[0].threshold #=> Integer
resp.trust_anchors[0].source.source_data.acm_pca_arn #=> String
resp.trust_anchors[0].source.source_data.x509_certificate_data #=> String
resp.trust_anchors[0].source.source_type #=> String, one of "AWS_ACM_PCA", "CERTIFICATE_BUNDLE", "SELF_SIGNED_REPOSITORY"
resp.trust_anchors[0].trust_anchor_arn #=> String
resp.trust_anchors[0].trust_anchor_id #=> String
resp.trust_anchors[0].updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    A token that indicates where the output should continue from, if a previous request did not show all results. To get the next results, make the request again with this value.

  • :page_size (Integer) —

    The number of resources in the paginated list.

Returns:

See Also:



1594
1595
1596
1597
 
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1594

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

#put_attribute_mapping(params = {}) ⇒ Types::PutAttributeMappingResponse

Put an entry in the attribute mapping rules that will be enforced by a given profile. A mapping specifies a certificate field and one or more specifiers that have contextual meanings.

Examples:

Request syntax with placeholder values


resp = client.put_attribute_mapping({
  certificate_field: "x509Subject", # required, accepts x509Subject, x509Issuer, x509SAN
  mapping_rules: [ # required
    {
      specifier: "MappingRuleSpecifierString", # required
    },
  ],
  profile_id: "Uuid", # required
})

Response structure


resp.profile.accept_role_session_name #=> Boolean
resp.profile.attribute_mappings #=> Array
resp.profile.attribute_mappings[0].certificate_field #=> String, one of "x509Subject", "x509Issuer", "x509SAN"
resp.profile.attribute_mappings[0].mapping_rules #=> Array
resp.profile.attribute_mappings[0].mapping_rules[0].specifier #=> String
resp.profile.created_at #=> Time
resp.profile.created_by #=> String
resp.profile.duration_seconds #=> Integer
resp.profile.enabled #=> Boolean
resp.profile.managed_policy_arns #=> Array
resp.profile.managed_policy_arns[0] #=> String
resp.profile.name #=> String
resp.profile.profile_arn #=> String
resp.profile.profile_id #=> String
resp.profile.require_instance_properties #=> Boolean
resp.profile.role_arns #=> Array
resp.profile.role_arns[0] #=> String
resp.profile.session_policy #=> String
resp.profile.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :certificate_field (required, String) —

    Fields (x509Subject, x509Issuer and x509SAN) within X.509 certificates.

  • :mapping_rules (required, Array<Types::MappingRule>) —

    A list of mapping entries for every supported specifier or sub-field.

  • :profile_id (required, String) —

    The unique identifier of the profile.

Returns:

See Also:



1655
1656
1657
1658
 
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1655

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

#put_notification_settings(params = {}) ⇒ Types::PutNotificationSettingsResponse

Attaches a list of notification settings to a trust anchor.

A notification setting includes information such as event name, threshold, status of the notification setting, and the channel to notify.

Required permissions: rolesanywhere:PutNotificationSettings.

Examples:

Request syntax with placeholder values


resp = client.put_notification_settings({
  notification_settings: [ # required
    {
      channel: "ALL", # accepts ALL
      enabled: false, # required
      event: "CA_CERTIFICATE_EXPIRY", # required, accepts CA_CERTIFICATE_EXPIRY, END_ENTITY_CERTIFICATE_EXPIRY
      threshold: 1,
    },
  ],
  trust_anchor_id: "Uuid", # required
})

Response structure


resp.trust_anchor.created_at #=> Time
resp.trust_anchor.enabled #=> Boolean
resp.trust_anchor.name #=> String
resp.trust_anchor.notification_settings #=> Array
resp.trust_anchor.notification_settings[0].channel #=> String, one of "ALL"
resp.trust_anchor.notification_settings[0].configured_by #=> String
resp.trust_anchor.notification_settings[0].enabled #=> Boolean
resp.trust_anchor.notification_settings[0].event #=> String, one of "CA_CERTIFICATE_EXPIRY", "END_ENTITY_CERTIFICATE_EXPIRY"
resp.trust_anchor.notification_settings[0].threshold #=> Integer
resp.trust_anchor.source.source_data.acm_pca_arn #=> String
resp.trust_anchor.source.source_data.x509_certificate_data #=> String
resp.trust_anchor.source.source_type #=> String, one of "AWS_ACM_PCA", "CERTIFICATE_BUNDLE", "SELF_SIGNED_REPOSITORY"
resp.trust_anchor.trust_anchor_arn #=> String
resp.trust_anchor.trust_anchor_id #=> String
resp.trust_anchor.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :notification_settings (required, Array<Types::NotificationSetting>) —

    A list of notification settings to be associated to the trust anchor.

  • :trust_anchor_id (required, String) —

    The unique identifier of the trust anchor.

Returns:

See Also:



1714
1715
1716
1717
 
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1714

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

#reset_notification_settings(params = {}) ⇒ Types::ResetNotificationSettingsResponse

Resets the custom notification setting to IAM Roles Anywhere default setting.

Required permissions: rolesanywhere:ResetNotificationSettings.

Examples:

Request syntax with placeholder values


resp = client.reset_notification_settings({
  notification_setting_keys: [ # required
    {
      channel: "ALL", # accepts ALL
      event: "CA_CERTIFICATE_EXPIRY", # required, accepts CA_CERTIFICATE_EXPIRY, END_ENTITY_CERTIFICATE_EXPIRY
    },
  ],
  trust_anchor_id: "Uuid", # required
})

Response structure


resp.trust_anchor.created_at #=> Time
resp.trust_anchor.enabled #=> Boolean
resp.trust_anchor.name #=> String
resp.trust_anchor.notification_settings #=> Array
resp.trust_anchor.notification_settings[0].channel #=> String, one of "ALL"
resp.trust_anchor.notification_settings[0].configured_by #=> String
resp.trust_anchor.notification_settings[0].enabled #=> Boolean
resp.trust_anchor.notification_settings[0].event #=> String, one of "CA_CERTIFICATE_EXPIRY", "END_ENTITY_CERTIFICATE_EXPIRY"
resp.trust_anchor.notification_settings[0].threshold #=> Integer
resp.trust_anchor.source.source_data.acm_pca_arn #=> String
resp.trust_anchor.source.source_data.x509_certificate_data #=> String
resp.trust_anchor.source.source_type #=> String, one of "AWS_ACM_PCA", "CERTIFICATE_BUNDLE", "SELF_SIGNED_REPOSITORY"
resp.trust_anchor.trust_anchor_arn #=> String
resp.trust_anchor.trust_anchor_id #=> String
resp.trust_anchor.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :notification_setting_keys (required, Array<Types::NotificationSettingKey>) —

    A list of notification setting keys to reset. A notification setting key includes the event and the channel.

  • :trust_anchor_id (required, String) —

    The unique identifier of the trust anchor.

Returns:

See Also:



1770
1771
1772
1773
 
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1770

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

#tag_resource(params = {}) ⇒ Struct

Attaches tags to a resource.

Required permissions: rolesanywhere:TagResource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "AmazonResourceName", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource.

  • :tags (required, Array<Types::Tag>) —

    The tags to attach to the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1803
1804
1805
1806
 
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1803

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

#untag_resource(params = {}) ⇒ Struct

Removes tags from the resource.

Required permissions: rolesanywhere:UntagResource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource.

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

    A list of keys. Tag keys are the unique identifiers of tags.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1831
1832
1833
1834
 
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1831

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

#update_crl(params = {}) ⇒ Types::CrlDetailResponse

Updates the certificate revocation list (CRL). A CRL is a list of certificates that have been revoked by the issuing certificate authority (CA). IAM Roles Anywhere validates against the CRL before issuing credentials.

Required permissions: rolesanywhere:UpdateCrl.

Examples:

Request syntax with placeholder values


resp = client.update_crl({
  crl_data: "data",
  crl_id: "Uuid", # required
  name: "ResourceName",
})

Response structure


resp.crl.created_at #=> Time
resp.crl.crl_arn #=> String
resp.crl.crl_data #=> String
resp.crl.crl_id #=> String
resp.crl.enabled #=> Boolean
resp.crl.name #=> String
resp.crl.trust_anchor_arn #=> String
resp.crl.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :crl_data (String, StringIO, File) —

    The x509 v3 specified certificate revocation list (CRL).

  • :crl_id (required, String) —

    The unique identifier of the certificate revocation list (CRL).

  • :name (String) —

    The name of the Crl.

Returns:

See Also:



1879
1880
1881
1882
 
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1879

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

#update_profile(params = {}) ⇒ Types::ProfileDetailResponse

Updates a profile, a list of the roles that IAM Roles Anywhere service is trusted to assume. You use profiles to intersect permissions with IAM managed policies.

Required permissions: rolesanywhere:UpdateProfile.

Examples:

Request syntax with placeholder values


resp = client.update_profile({
  accept_role_session_name: false,
  duration_seconds: 1,
  managed_policy_arns: ["ManagedPolicyListMemberString"],
  name: "ResourceName",
  profile_id: "Uuid", # required
  role_arns: ["RoleArn"],
  session_policy: "UpdateProfileRequestSessionPolicyString",
})

Response structure


resp.profile.accept_role_session_name #=> Boolean
resp.profile.attribute_mappings #=> Array
resp.profile.attribute_mappings[0].certificate_field #=> String, one of "x509Subject", "x509Issuer", "x509SAN"
resp.profile.attribute_mappings[0].mapping_rules #=> Array
resp.profile.attribute_mappings[0].mapping_rules[0].specifier #=> String
resp.profile.created_at #=> Time
resp.profile.created_by #=> String
resp.profile.duration_seconds #=> Integer
resp.profile.enabled #=> Boolean
resp.profile.managed_policy_arns #=> Array
resp.profile.managed_policy_arns[0] #=> String
resp.profile.name #=> String
resp.profile.profile_arn #=> String
resp.profile.profile_id #=> String
resp.profile.require_instance_properties #=> Boolean
resp.profile.role_arns #=> Array
resp.profile.role_arns[0] #=> String
resp.profile.session_policy #=> String
resp.profile.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :accept_role_session_name (Boolean) —

    Used to determine if a custom role session name will be accepted in a temporary credential request.

  • :duration_seconds (Integer) —

    Used to determine how long sessions vended using this profile are valid for. See the Expiration section of the CreateSession API documentation page for more details. In requests, if this value is not provided, the default value will be 3600.

  • :managed_policy_arns (Array<String>) —

    A list of managed policy ARNs that apply to the vended session credentials.

  • :name (String) —

    The name of the profile.

  • :profile_id (required, String) —

    The unique identifier of the profile.

  • :role_arns (Array<String>) —

    A list of IAM roles that this profile can assume in a temporary credential request.

  • :session_policy (String) —

    A session policy that applies to the trust boundary of the vended session credentials.

Returns:

See Also:



1964
1965
1966
1967
 
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 1964

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

#update_trust_anchor(params = {}) ⇒ Types::TrustAnchorDetailResponse

Updates a trust anchor. You establish trust between IAM Roles Anywhere and your certificate authority (CA) by configuring a trust anchor. You can define a trust anchor as a reference to an Private Certificate Authority (Private CA) or by uploading a CA certificate. Your Amazon Web Services workloads can authenticate with the trust anchor using certificates issued by the CA in exchange for temporary Amazon Web Services credentials.

Required permissions: rolesanywhere:UpdateTrustAnchor.

Examples:

Request syntax with placeholder values


resp = client.update_trust_anchor({
  name: "ResourceName",
  source: {
    source_data: {
      acm_pca_arn: "String",
      x509_certificate_data: "SourceDataX509CertificateDataString",
    },
    source_type: "AWS_ACM_PCA", # accepts AWS_ACM_PCA, CERTIFICATE_BUNDLE, SELF_SIGNED_REPOSITORY
  },
  trust_anchor_id: "Uuid", # required
})

Response structure


resp.trust_anchor.created_at #=> Time
resp.trust_anchor.enabled #=> Boolean
resp.trust_anchor.name #=> String
resp.trust_anchor.notification_settings #=> Array
resp.trust_anchor.notification_settings[0].channel #=> String, one of "ALL"
resp.trust_anchor.notification_settings[0].configured_by #=> String
resp.trust_anchor.notification_settings[0].enabled #=> Boolean
resp.trust_anchor.notification_settings[0].event #=> String, one of "CA_CERTIFICATE_EXPIRY", "END_ENTITY_CERTIFICATE_EXPIRY"
resp.trust_anchor.notification_settings[0].threshold #=> Integer
resp.trust_anchor.source.source_data.acm_pca_arn #=> String
resp.trust_anchor.source.source_data.x509_certificate_data #=> String
resp.trust_anchor.source.source_type #=> String, one of "AWS_ACM_PCA", "CERTIFICATE_BUNDLE", "SELF_SIGNED_REPOSITORY"
resp.trust_anchor.trust_anchor_arn #=> String
resp.trust_anchor.trust_anchor_id #=> String
resp.trust_anchor.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :name (String) —

    The name of the trust anchor.

  • :source (Types::Source) —

    The trust anchor type and its related certificate data.

  • :trust_anchor_id (required, String) —

    The unique identifier of the trust anchor.

Returns:

See Also:



2028
2029
2030
2031
 
# File 'gems/aws-sdk-rolesanywhere/lib/aws-sdk-rolesanywhere/client.rb', line 2028

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