Class: Aws::MPA::Client

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

Overview

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

client = Aws::MPA::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::MPA::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::MPA::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-mpa/lib/aws-sdk-mpa/client.rb', line 473

def initialize(*args)
  super
end

Instance Method Details

#cancel_session(params = {}) ⇒ Struct

Cancels an approval session. For more information, see Session in the Multi-party approval User Guide.

Examples:

Request syntax with placeholder values


resp = client.cancel_session({
  session_arn: "SessionArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :session_arn (required, String) —

    Amazon Resource Name (ARN) for the session.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



501
502
503
504
 
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/client.rb', line 501

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

#create_approval_team(params = {}) ⇒ Types::CreateApprovalTeamResponse

Creates a new approval team. For more information, see Approval team in the Multi-party approval User Guide.

Examples:

Request syntax with placeholder values


resp = client.create_approval_team({
  client_token: "Token",
  approval_strategy: { # required
    mof_n: {
      min_approvals_required: 1, # required
    },
  },
  approvers: [ # required
    {
      primary_identity_id: "IdentityId", # required
      primary_identity_source_arn: "String", # required
    },
  ],
  description: "Description", # required
  policies: [ # required
    {
      policy_arn: "QualifiedPolicyArn", # required
    },
  ],
  name: "ApprovalTeamName", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.creation_time #=> Time
resp.arn #=> String
resp.name #=> String
resp.version_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services populates this field.

    What is idempotency?

    When you make a mutating API request, the request typically returns a result before the operation's asynchronous workflows have completed. Operations might also time out or encounter other server issues before they complete, even though the request has already returned a result. This could make it difficult to determine whether the request succeeded or not, and could lead to multiple retries to ensure that the operation completes successfully. However, if the original request and the subsequent retries are successful, the operation is completed multiple times. This means that you might create more resources than you intended.

    Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries complete successfully without performing any further actions.

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

  • :approval_strategy (required, Types::ApprovalStrategy) —

    An ApprovalStrategy object. Contains details for how the team grants approval.

  • :approvers (required, Array<Types::ApprovalTeamRequestApprover>) —

    An array of ApprovalTeamRequesterApprovers objects. Contains details for the approvers in the team.

  • :description (required, String) —

    Description for the team.

  • :policies (required, Array<Types::PolicyReference>) —

    An array of PolicyReference objects. Contains a list of policies that define the permissions for team resources.

  • :name (required, String) —

    Name of the team.

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

    Tags you want to attach to the team.

Returns:

See Also:



607
608
609
610
 
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/client.rb', line 607

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

#create_identity_source(params = {}) ⇒ Types::CreateIdentitySourceResponse

Creates a new identity source. For more information, see Identity Source in the Multi-party approval User Guide.

Examples:

Request syntax with placeholder values


resp = client.create_identity_source({
  identity_source_parameters: { # required
    iam_identity_center: {
      instance_arn: "IdcInstanceArn", # required
      region: "String", # required
    },
  },
  client_token: "Token",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.identity_source_type #=> String, one of "IAM_IDENTITY_CENTER"
resp.identity_source_arn #=> String
resp.creation_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :identity_source_parameters (required, Types::IdentitySourceParameters) —

    A IdentitySourceParameters object. Contains details for the resource that provides identities to the identity source. For example, an IAM Identity Center instance.

  • :client_token (String) —

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services populates this field.

    What is idempotency?

    When you make a mutating API request, the request typically returns a result before the operation's asynchronous workflows have completed. Operations might also time out or encounter other server issues before they complete, even though the request has already returned a result. This could make it difficult to determine whether the request succeeded or not, and could lead to multiple retries to ensure that the operation completes successfully. However, if the original request and the subsequent retries are successful, the operation is completed multiple times. This means that you might create more resources than you intended.

    Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries complete successfully without performing any further actions.

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

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

    Tag you want to attach to the identity source.

Returns:

See Also:



686
687
688
689
 
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/client.rb', line 686

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

#delete_identity_source(params = {}) ⇒ Struct

Deletes an identity source. For more information, see Identity Source in the Multi-party approval User Guide.

Examples:

Request syntax with placeholder values


resp = client.delete_identity_source({
  identity_source_arn: "String", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :identity_source_arn (required, String) —

    Amazon Resource Name (ARN) for identity source.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

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

#delete_inactive_approval_team_version(params = {}) ⇒ Struct

Deletes an inactive approval team. For more information, see Team health in the Multi-party approval User Guide.

You can also use this operation to delete a team draft. For more information, see Interacting with drafts in the Multi-party approval User Guide.

Examples:

Request syntax with placeholder values


resp = client.delete_inactive_approval_team_version({
  arn: "ApprovalTeamArn", # required
  version_id: "String", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :arn (required, String) —

    Amaazon Resource Name (ARN) for the team.

  • :version_id (required, String) —

    Version ID for the team.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

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

#get_approval_team(params = {}) ⇒ Types::GetApprovalTeamResponse

Returns details for an approval team.

Examples:

Request syntax with placeholder values


resp = client.get_approval_team({
  arn: "ApprovalTeamArn", # required
})

Response structure


resp.creation_time #=> Time
resp.approval_strategy.mof_n.min_approvals_required #=> Integer
resp.number_of_approvers #=> Integer
resp.approvers #=> Array
resp.approvers[0].approver_id #=> String
resp.approvers[0].response_time #=> Time
resp.approvers[0].primary_identity_id #=> String
resp.approvers[0].primary_identity_source_arn #=> String
resp.approvers[0].primary_identity_status #=> String, one of "PENDING", "ACCEPTED", "REJECTED", "INVALID"
resp.approvers[0].mfa_methods #=> Array
resp.approvers[0].mfa_methods[0].type #=> String, one of "EMAIL_OTP"
resp.approvers[0].mfa_methods[0].sync_status #=> String, one of "IN_SYNC", "OUT_OF_SYNC"
resp.arn #=> String
resp.description #=> String
resp.name #=> String
resp.status #=> String, one of "ACTIVE", "INACTIVE", "DELETING", "PENDING"
resp.status_code #=> String, one of "VALIDATING", "PENDING_ACTIVATION", "FAILED_VALIDATION", "FAILED_ACTIVATION", "UPDATE_PENDING_APPROVAL", "UPDATE_PENDING_ACTIVATION", "UPDATE_FAILED_APPROVAL", "UPDATE_FAILED_ACTIVATION", "UPDATE_FAILED_VALIDATION", "DELETE_PENDING_APPROVAL", "DELETE_FAILED_APPROVAL", "DELETE_FAILED_VALIDATION"
resp.status_message #=> String
resp.update_session_arn #=> String
resp.version_id #=> String
resp.policies #=> Array
resp.policies[0].policy_arn #=> String
resp.last_update_time #=> Time
resp.pending_update.version_id #=> String
resp.pending_update.description #=> String
resp.pending_update.approval_strategy.mof_n.min_approvals_required #=> Integer
resp.pending_update.number_of_approvers #=> Integer
resp.pending_update.status #=> String, one of "ACTIVE", "INACTIVE", "DELETING", "PENDING"
resp.pending_update.status_code #=> String, one of "VALIDATING", "PENDING_ACTIVATION", "FAILED_VALIDATION", "FAILED_ACTIVATION", "UPDATE_PENDING_APPROVAL", "UPDATE_PENDING_ACTIVATION", "UPDATE_FAILED_APPROVAL", "UPDATE_FAILED_ACTIVATION", "UPDATE_FAILED_VALIDATION", "DELETE_PENDING_APPROVAL", "DELETE_FAILED_APPROVAL", "DELETE_FAILED_VALIDATION"
resp.pending_update.status_message #=> String
resp.pending_update.approvers #=> Array
resp.pending_update.approvers[0].approver_id #=> String
resp.pending_update.approvers[0].response_time #=> Time
resp.pending_update.approvers[0].primary_identity_id #=> String
resp.pending_update.approvers[0].primary_identity_source_arn #=> String
resp.pending_update.approvers[0].primary_identity_status #=> String, one of "PENDING", "ACCEPTED", "REJECTED", "INVALID"
resp.pending_update.approvers[0].mfa_methods #=> Array
resp.pending_update.approvers[0].mfa_methods[0].type #=> String, one of "EMAIL_OTP"
resp.pending_update.approvers[0].mfa_methods[0].sync_status #=> String, one of "IN_SYNC", "OUT_OF_SYNC"
resp.pending_update.update_initiation_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :arn (required, String) —

    Amazon Resource Name (ARN) for the team.

Returns:

See Also:



830
831
832
833
 
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/client.rb', line 830

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

#get_identity_source(params = {}) ⇒ Types::GetIdentitySourceResponse

Returns details for an identity source. For more information, see Identity Source in the Multi-party approval User Guide.

Examples:

Request syntax with placeholder values


resp = client.get_identity_source({
  identity_source_arn: "String", # required
})

Response structure


resp.identity_source_type #=> String, one of "IAM_IDENTITY_CENTER"
resp.identity_source_parameters.iam_identity_center.instance_arn #=> String
resp.identity_source_parameters.iam_identity_center.approval_portal_url #=> String
resp.identity_source_parameters.iam_identity_center.region #=> String
resp.identity_source_arn #=> String
resp.creation_time #=> Time
resp.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "ERROR"
resp.status_code #=> String, one of "ACCESS_DENIED", "DELETION_FAILED", "IDC_INSTANCE_NOT_FOUND", "IDC_INSTANCE_NOT_VALID"
resp.status_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :identity_source_arn (required, String) —

    Amazon Resource Name (ARN) for the identity source.

Returns:

See Also:



877
878
879
880
 
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/client.rb', line 877

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

#get_policy_version(params = {}) ⇒ Types::GetPolicyVersionResponse

Returns details for the version of a policy. Policies define the permissions for team resources.

Examples:

Request syntax with placeholder values


resp = client.get_policy_version({
  policy_version_arn: "QualifiedPolicyArn", # required
})

Response structure


resp.policy_version.arn #=> String
resp.policy_version.policy_arn #=> String
resp.policy_version.version_id #=> Integer
resp.policy_version.policy_type #=> String, one of "AWS_MANAGED", "AWS_RAM"
resp.policy_version.is_default #=> Boolean
resp.policy_version.name #=> String
resp.policy_version.status #=> String, one of "ATTACHABLE", "DEPRECATED"
resp.policy_version.creation_time #=> Time
resp.policy_version.last_updated_time #=> Time
resp.policy_version.document #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :policy_version_arn (required, String) —

    Amazon Resource Name (ARN) for the policy.

Returns:

See Also:



915
916
917
918
 
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/client.rb', line 915

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

#get_resource_policy(params = {}) ⇒ Types::GetResourcePolicyResponse

Returns details about a policy for a resource.

Examples:

Request syntax with placeholder values


resp = client.get_resource_policy({
  resource_arn: "String", # required
  policy_name: "String", # required
  policy_type: "AWS_MANAGED", # required, accepts AWS_MANAGED, AWS_RAM
})

Response structure


resp.resource_arn #=> String
resp.policy_type #=> String, one of "AWS_MANAGED", "AWS_RAM"
resp.policy_version_arn #=> String
resp.policy_name #=> String
resp.policy_document #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    Amazon Resource Name (ARN) for the resource.

  • :policy_name (required, String) —

    Name of the policy.

  • :policy_type (required, String) —

    The type of policy.

Returns:

See Also:



959
960
961
962
 
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/client.rb', line 959

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

#get_session(params = {}) ⇒ Types::GetSessionResponse

Returns details for an approval session. For more information, see Session in the Multi-party approval User Guide.

Examples:

Request syntax with placeholder values


resp = client.get_session({
  session_arn: "SessionArn", # required
})

Response structure


resp.session_arn #=> String
resp.approval_team_arn #=> String
resp.approval_team_name #=> String
resp.protected_resource_arn #=> String
resp.approval_strategy.mof_n.min_approvals_required #=> Integer
resp.number_of_approvers #=> Integer
resp.initiation_time #=> Time
resp.expiration_time #=> Time
resp.completion_time #=> Time
resp.description #=> String
resp.metadata #=> Hash
resp.metadata["SessionKey"] #=> String
resp.status #=> String, one of "PENDING", "CANCELLED", "APPROVED", "FAILED", "CREATING"
resp.status_code #=> String, one of "REJECTED", "EXPIRED", "CONFIGURATION_CHANGED"
resp.status_message #=> String
resp.execution_status #=> String, one of "EXECUTED", "FAILED", "PENDING"
resp.action_name #=> String
resp.requester_service_principal #=> String
resp.requester_principal_arn #=> String
resp. #=> String
resp.requester_region #=> String
resp.requester_comment #=> String
resp.action_completion_strategy #=> String, one of "AUTO_COMPLETION_UPON_APPROVAL"
resp.approver_responses #=> Array
resp.approver_responses[0].approver_id #=> String
resp.approver_responses[0].identity_source_arn #=> String
resp.approver_responses[0].identity_id #=> String
resp.approver_responses[0].response #=> String, one of "APPROVED", "REJECTED", "NO_RESPONSE"
resp.approver_responses[0].response_time #=> Time
resp.additional_security_requirements #=> Array
resp.additional_security_requirements[0] #=> String, one of "APPROVER_VERIFICATION_REQUIRED"

Parameters:

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

    ({})

Options Hash (params):

  • :session_arn (required, String) —

    Amazon Resource Name (ARN) for the session.

Returns:

See Also:



1045
1046
1047
1048
 
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/client.rb', line 1045

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

#list_approval_teams(params = {}) ⇒ Types::ListApprovalTeamsResponse

Returns a list of approval teams.

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_approval_teams({
  max_results: 1,
  next_token: "Token",
})

Response structure


resp.next_token #=> String
resp.approval_teams #=> Array
resp.approval_teams[0].creation_time #=> Time
resp.approval_teams[0].approval_strategy.mof_n.min_approvals_required #=> Integer
resp.approval_teams[0].number_of_approvers #=> Integer
resp.approval_teams[0].arn #=> String
resp.approval_teams[0].name #=> String
resp.approval_teams[0].description #=> String
resp.approval_teams[0].status #=> String, one of "ACTIVE", "INACTIVE", "DELETING", "PENDING"
resp.approval_teams[0].status_code #=> String, one of "VALIDATING", "PENDING_ACTIVATION", "FAILED_VALIDATION", "FAILED_ACTIVATION", "UPDATE_PENDING_APPROVAL", "UPDATE_PENDING_ACTIVATION", "UPDATE_FAILED_APPROVAL", "UPDATE_FAILED_ACTIVATION", "UPDATE_FAILED_VALIDATION", "DELETE_PENDING_APPROVAL", "DELETE_FAILED_APPROVAL", "DELETE_FAILED_VALIDATION"
resp.approval_teams[0].status_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.

  • :next_token (String) —

    If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a next call to the operation to get more output. You can repeat this until the NextToken response element returns null.

Returns:

See Also:



1095
1096
1097
1098
 
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/client.rb', line 1095

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

#list_identity_sources(params = {}) ⇒ Types::ListIdentitySourcesResponse

Returns a list of identity sources. For more information, see Identity Source in the Multi-party approval User Guide.

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_identity_sources({
  max_results: 1,
  next_token: "Token",
})

Response structure


resp.next_token #=> String
resp.identity_sources #=> Array
resp.identity_sources[0].identity_source_type #=> String, one of "IAM_IDENTITY_CENTER"
resp.identity_sources[0].identity_source_parameters.iam_identity_center.instance_arn #=> String
resp.identity_sources[0].identity_source_parameters.iam_identity_center.approval_portal_url #=> String
resp.identity_sources[0].identity_source_parameters.iam_identity_center.region #=> String
resp.identity_sources[0].identity_source_arn #=> String
resp.identity_sources[0].creation_time #=> Time
resp.identity_sources[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "ERROR"
resp.identity_sources[0].status_code #=> String, one of "ACCESS_DENIED", "DELETION_FAILED", "IDC_INSTANCE_NOT_FOUND", "IDC_INSTANCE_NOT_VALID"
resp.identity_sources[0].status_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.

  • :next_token (String) —

    If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a next call to the operation to get more output. You can repeat this until the NextToken response element returns null.

Returns:

See Also:



1150
1151
1152
1153
 
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/client.rb', line 1150

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

#list_policies(params = {}) ⇒ Types::ListPoliciesResponse

Returns a list of policies. Policies define the permissions for team resources.

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_policies({
  max_results: 1,
  next_token: "Token",
})

Response structure


resp.next_token #=> String
resp.policies #=> Array
resp.policies[0].arn #=> String
resp.policies[0].default_version #=> Integer
resp.policies[0].policy_type #=> String, one of "AWS_MANAGED", "AWS_RAM"
resp.policies[0].name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.

  • :next_token (String) —

    If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a next call to the operation to get more output. You can repeat this until the NextToken response element returns null.

Returns:

See Also:



1196
1197
1198
1199
 
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/client.rb', line 1196

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

#list_policy_versions(params = {}) ⇒ Types::ListPolicyVersionsResponse

Returns a list of the versions for policies. Policies define the permissions for team resources.

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_policy_versions({
  max_results: 1,
  next_token: "Token",
  policy_arn: "UnqualifiedPolicyArn", # required
})

Response structure


resp.next_token #=> String
resp.policy_versions #=> Array
resp.policy_versions[0].arn #=> String
resp.policy_versions[0].policy_arn #=> String
resp.policy_versions[0].version_id #=> Integer
resp.policy_versions[0].policy_type #=> String, one of "AWS_MANAGED", "AWS_RAM"
resp.policy_versions[0].is_default #=> Boolean
resp.policy_versions[0].name #=> String
resp.policy_versions[0].status #=> String, one of "ATTACHABLE", "DEPRECATED"
resp.policy_versions[0].creation_time #=> Time
resp.policy_versions[0].last_updated_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.

  • :next_token (String) —

    If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a next call to the operation to get more output. You can repeat this until the NextToken response element returns null.

  • :policy_arn (required, String) —

    Amazon Resource Name (ARN) for the policy.

Returns:

See Also:



1251
1252
1253
1254
 
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/client.rb', line 1251

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

#list_resource_policies(params = {}) ⇒ Types::ListResourcePoliciesResponse

Returns a list of policies for a resource.

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_resource_policies({
  resource_arn: "String", # required
  max_results: 1,
  next_token: "Token",
})

Response structure


resp.next_token #=> String
resp.resource_policies #=> Array
resp.resource_policies[0].policy_arn #=> String
resp.resource_policies[0].policy_type #=> String, one of "AWS_MANAGED", "AWS_RAM"
resp.resource_policies[0].policy_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    Amazon Resource Name (ARN) for the resource.

  • :max_results (Integer) —

    The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.

  • :next_token (String) —

    If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a next call to the operation to get more output. You can repeat this until the NextToken response element returns null.

Returns:

See Also:



1299
1300
1301
1302
 
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/client.rb', line 1299

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

#list_sessions(params = {}) ⇒ Types::ListSessionsResponse

Returns a list of approval sessions. For more information, see Session in the Multi-party approval User Guide.

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_sessions({
  approval_team_arn: "ApprovalTeamArn", # required
  max_results: 1,
  next_token: "Token",
  filters: [
    {
      field_name: "ActionName", # accepts ActionName, ApprovalTeamName, VotingTime, Vote, SessionStatus, InitiationTime
      operator: "EQ", # accepts EQ, NE, GT, LT, GTE, LTE, CONTAINS, NOT_CONTAINS, BETWEEN
      value: "String",
    },
  ],
})

Response structure


resp.next_token #=> String
resp.sessions #=> Array
resp.sessions[0].session_arn #=> String
resp.sessions[0].approval_team_name #=> String
resp.sessions[0].approval_team_arn #=> String
resp.sessions[0].initiation_time #=> Time
resp.sessions[0].expiration_time #=> Time
resp.sessions[0].completion_time #=> Time
resp.sessions[0].description #=> String
resp.sessions[0].action_name #=> String
resp.sessions[0].protected_resource_arn #=> String
resp.sessions[0].requester_service_principal #=> String
resp.sessions[0].requester_principal_arn #=> String
resp.sessions[0].requester_region #=> String
resp.sessions[0]. #=> String
resp.sessions[0].status #=> String, one of "PENDING", "CANCELLED", "APPROVED", "FAILED", "CREATING"
resp.sessions[0].status_code #=> String, one of "REJECTED", "EXPIRED", "CONFIGURATION_CHANGED"
resp.sessions[0].status_message #=> String
resp.sessions[0].action_completion_strategy #=> String, one of "AUTO_COMPLETION_UPON_APPROVAL"
resp.sessions[0].additional_security_requirements #=> Array
resp.sessions[0].additional_security_requirements[0] #=> String, one of "APPROVER_VERIFICATION_REQUIRED"

Parameters:

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

    ({})

Options Hash (params):

  • :approval_team_arn (required, String) —

    Amazon Resource Name (ARN) for the approval team.

  • :max_results (Integer) —

    The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.

  • :next_token (String) —

    If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a next call to the operation to get more output. You can repeat this until the NextToken response element returns null.

  • :filters (Array<Types::Filter>) —

    An array of Filter objects. Contains the filter to apply when listing sessions.

Returns:

See Also:



1379
1380
1381
1382
 
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/client.rb', line 1379

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

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

Returns a list of the 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["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    Amazon Resource Name (ARN) for the resource.

Returns:

See Also:



1408
1409
1410
1411
 
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/client.rb', line 1408

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

#start_active_approval_team_deletion(params = {}) ⇒ Types::StartActiveApprovalTeamDeletionResponse

Starts the deletion process for an active approval team.

Deletions require team approval

Requests to delete an active team must be approved by the team.

Examples:

Request syntax with placeholder values


resp = client.start_active_approval_team_deletion({
  pending_window_days: 1,
  arn: "ApprovalTeamArn", # required
})

Response structure


resp.deletion_completion_time #=> Time
resp.deletion_start_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :pending_window_days (Integer) —

    Number of days between when the team approves the delete request and when the team is deleted.

  • :arn (required, String) —

    Amazon Resource Name (ARN) for the team.

Returns:

See Also:



1449
1450
1451
1452
 
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/client.rb', line 1449

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

#tag_resource(params = {}) ⇒ Struct

Creates or updates a resource tag. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    Amazon Resource Name (ARN) for the resource you want to tag.

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

    Tags that you have added to the specified resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1479
1480
1481
1482
 
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/client.rb', line 1479

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

#untag_resource(params = {}) ⇒ Struct

Removes a resource tag. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    Amazon Resource Name (ARN) for the resource you want to untag.

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

    Array of tag key-value pairs that you want to untag.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

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

#update_approval_team(params = {}) ⇒ Types::UpdateApprovalTeamResponse

Updates an approval team. You can request to update the team description, approval threshold, and approvers in the team.

Updates require team approval

Updates to an active team must be approved by the team.

Examples:

Request syntax with placeholder values


resp = client.update_approval_team({
  approval_strategy: {
    mof_n: {
      min_approvals_required: 1, # required
    },
  },
  approvers: [
    {
      primary_identity_id: "IdentityId", # required
      primary_identity_source_arn: "String", # required
    },
  ],
  description: "Description",
  arn: "ApprovalTeamArn", # required
  update_actions: ["SYNCHRONIZE_MFA_DEVICES"], # accepts SYNCHRONIZE_MFA_DEVICES
})

Response structure


resp.version_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :approval_strategy (Types::ApprovalStrategy) —

    An ApprovalStrategy object. Contains details for how the team grants approval.

  • :approvers (Array<Types::ApprovalTeamRequestApprover>) —

    An array of ApprovalTeamRequestApprover objects. Contains details for the approvers in the team.

  • :description (String) —

    Description for the team.

  • :arn (required, String) —

    Amazon Resource Name (ARN) for the team.

  • :update_actions (Array<String>) —

    A list of UpdateAction to perform when updating the team.

Returns:

See Also:



1569
1570
1571
1572
 
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/client.rb', line 1569

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