Class: Aws::CognitoIdentity::Client

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

Overview

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

client = Aws::CognitoIdentity::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 Aws::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. Takes effect only when disable_clock_skew_correction is not set.

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

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

  • :disable_clock_skew_correction (Boolean) —

    Used only in standard and adaptive retry modes. When true, the SDK does not apply a clock skew correction, does not update its stored skew from responses, and does not retry clock skew errors. Clock skew correction is enabled by default.

  • :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 the 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 - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

  • :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
  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

  • :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 Aws::ClientStubs#stub_responses. See Aws::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::CognitoIdentity::EndpointProvider) —

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



485
486
487
 
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 485

def initialize(*args)
  super
end

Instance Method Details

#create_identity_pool(params = {}) ⇒ Types::IdentityPool

Creates a new identity pool. The identity pool is a store of user identity information that is specific to your Amazon Web Services account. The keys for SupportedLoginProviders are as follows:

  • Facebook: graph.facebook.com

  • Google: accounts.google.com

  • Sign in With Apple: appleid.apple.com

  • Amazon: www.amazon.com

  • Twitter: api.twitter.com

  • Digits: www.digits.com

If you don't provide a value for a parameter, Amazon Cognito sets it to its default value.

You must use Amazon Web Services developer credentials to call this operation.

Examples:

Request syntax with placeholder values


resp = client.create_identity_pool({
  identity_pool_name: "IdentityPoolName", # required
  allow_unauthenticated_identities: false, # required
  allow_classic_flow: false,
  supported_login_providers: {
    "IdentityProviderName" => "IdentityProviderId",
  },
  developer_provider_name: "DeveloperProviderName",
  open_id_connect_provider_arns: ["ARNString"],
  cognito_identity_providers: [
    {
      provider_name: "CognitoIdentityProviderName",
      client_id: "CognitoIdentityProviderClientId",
      server_side_token_check: false,
    },
  ],
  saml_provider_arns: ["ARNString"],
  identity_pool_tags: {
    "TagKeysType" => "TagValueType",
  },
})

Response structure


resp.identity_pool_id #=> String
resp.identity_pool_name #=> String
resp.allow_unauthenticated_identities #=> Boolean
resp.allow_classic_flow #=> Boolean
resp. #=> Hash
resp.["IdentityProviderName"] #=> String
resp.developer_provider_name #=> String
resp.open_id_connect_provider_arns #=> Array
resp.open_id_connect_provider_arns[0] #=> String
resp.cognito_identity_providers #=> Array
resp.cognito_identity_providers[0].provider_name #=> String
resp.cognito_identity_providers[0].client_id #=> String
resp.cognito_identity_providers[0].server_side_token_check #=> Boolean
resp.saml_provider_arns #=> Array
resp.saml_provider_arns[0] #=> String
resp.identity_pool_tags #=> Hash
resp.identity_pool_tags["TagKeysType"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :identity_pool_name (required, String) —

    A string that you provide.

  • :allow_unauthenticated_identities (required, Boolean) —

    TRUE if the identity pool supports unauthenticated logins.

  • :allow_classic_flow (Boolean) —

    Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.

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

    Optional key:value pairs mapping provider names to provider app IDs.

  • :developer_provider_name (String) —

    The "domain" by which Cognito will refer to your users. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName, you can use letters as well as period (.), underscore (_), and dash (-).

    Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter.

  • :open_id_connect_provider_arns (Array<String>) —

    The Amazon Resource Names (ARN) of the OpenID Connect providers.

  • :cognito_identity_providers (Array<Types::CognitoIdentityProvider>) —

    An array of Amazon Cognito user pools and their client IDs.

  • :saml_provider_arns (Array<String>) —

    An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.

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

    Tags to assign to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

Returns:

See Also:



617
618
619
620
 
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 617

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

#delete_identities(params = {}) ⇒ Types::DeleteIdentitiesResponse

Deletes identities from an identity pool. You can specify a list of 1-60 identities that you want to delete.

You must use Amazon Web Services developer credentials to call this operation.

Examples:

Request syntax with placeholder values


resp = client.delete_identities({
  identity_ids_to_delete: ["IdentityId"], # required
})

Response structure


resp.unprocessed_identity_ids #=> Array
resp.unprocessed_identity_ids[0].identity_id #=> String
resp.unprocessed_identity_ids[0].error_code #=> String, one of "AccessDenied", "InternalServerError"

Parameters:

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

    ({})

Options Hash (params):

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

    A list of 1-60 identities that you want to delete.

Returns:

See Also:



651
652
653
654
 
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 651

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

#delete_identity_pool(params = {}) ⇒ Struct

Deletes an identity pool. Once a pool is deleted, users will not be able to authenticate with the pool.

You must use Amazon Web Services developer credentials to call this operation.

Examples:

Request syntax with placeholder values


resp = client.delete_identity_pool({
  identity_pool_id: "IdentityPoolId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :identity_pool_id (required, String) —

    An identity pool ID in the format REGION:GUID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



677
678
679
680
 
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 677

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

#describe_identity(params = {}) ⇒ Types::IdentityDescription

Returns metadata related to the given identity, including when the identity was created and any associated linked logins.

You must use Amazon Web Services developer credentials to call this operation.

Examples:

Request syntax with placeholder values


resp = client.describe_identity({
  identity_id: "IdentityId", # required
})

Response structure


resp.identity_id #=> String
resp.logins #=> Array
resp.logins[0] #=> String
resp.creation_date #=> Time
resp.last_modified_date #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :identity_id (required, String) —

    A unique identifier in the format REGION:GUID.

Returns:

See Also:



716
717
718
719
 
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 716

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

#describe_identity_pool(params = {}) ⇒ Types::IdentityPool

Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.

You must use Amazon Web Services developer credentials to call this operation.

Examples:

Request syntax with placeholder values


resp = client.describe_identity_pool({
  identity_pool_id: "IdentityPoolId", # required
})

Response structure


resp.identity_pool_id #=> String
resp.identity_pool_name #=> String
resp.allow_unauthenticated_identities #=> Boolean
resp.allow_classic_flow #=> Boolean
resp. #=> Hash
resp.["IdentityProviderName"] #=> String
resp.developer_provider_name #=> String
resp.open_id_connect_provider_arns #=> Array
resp.open_id_connect_provider_arns[0] #=> String
resp.cognito_identity_providers #=> Array
resp.cognito_identity_providers[0].provider_name #=> String
resp.cognito_identity_providers[0].client_id #=> String
resp.cognito_identity_providers[0].server_side_token_check #=> Boolean
resp.saml_provider_arns #=> Array
resp.saml_provider_arns[0] #=> String
resp.identity_pool_tags #=> Hash
resp.identity_pool_tags["TagKeysType"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :identity_pool_id (required, String) —

    An identity pool ID in the format REGION:GUID.

Returns:

See Also:



773
774
775
776
 
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 773

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

#get_credentials_for_identity(params = {}) ⇒ Types::GetCredentialsForIdentityResponse

Returns credentials for the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to Security Token Service with the appropriate role for the token.

This is a public API. You do not need any credentials to call this API.

Examples:

Request syntax with placeholder values


resp = client.get_credentials_for_identity({
  identity_id: "IdentityId", # required
  logins: {
    "IdentityProviderName" => "IdentityProviderToken",
  },
  custom_role_arn: "ARNString",
})

Response structure


resp.identity_id #=> String
resp.credentials.access_key_id #=> String
resp.credentials.secret_key #=> String
resp.credentials.session_token #=> String
resp.credentials.expiration #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :identity_id (required, String) —

    A unique identifier in the format REGION:GUID.

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

    A set of optional name-value pairs that map provider names to provider tokens. The name-value pair will follow the syntax "provider_name": "provider_user_identifier".

    Logins should not be specified when trying to get credentials for an unauthenticated identity.

    The Logins parameter is required when using identities associated with external identity providers such as Facebook. For examples of Logins maps, see the code examples in the External Identity Providers section of the Amazon Cognito Developer Guide.

  • :custom_role_arn (String) —

    The Amazon Resource Name (ARN) of the role to be assumed when multiple roles were received in the token from the identity provider. For example, a SAML-based identity provider. This parameter is optional for identity providers that do not support role customization.

Returns:

See Also:



839
840
841
842
 
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 839

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

#get_id(params = {}) ⇒ Types::GetIdResponse

Generates (or retrieves) IdentityID. Supplying multiple logins will create an implicit linked account.

This is a public API. You do not need any credentials to call this API.

Examples:

Request syntax with placeholder values


resp = client.get_id({
  account_id: "AccountId",
  identity_pool_id: "IdentityPoolId", # required
  logins: {
    "IdentityProviderName" => "IdentityProviderToken",
  },
})

Response structure


resp.identity_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_id (String) —

    A standard Amazon Web Services account ID (9+ digits).

  • :identity_pool_id (required, String) —

    An identity pool ID in the format REGION:GUID.

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

    A set of optional name-value pairs that map provider names to provider tokens. The available provider names for Logins are as follows:

    • Facebook: graph.facebook.com

    • Amazon Cognito user pool: cognito-idp.<region>.amazonaws.com/<YOUR_USER_POOL_ID>, for example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789.

    • Google: accounts.google.com

    • Amazon: www.amazon.com

    • Twitter: api.twitter.com

    • Digits: www.digits.com

Returns:

See Also:



896
897
898
899
 
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 896

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

#get_identity_pool_roles(params = {}) ⇒ Types::GetIdentityPoolRolesResponse

Gets the roles for an identity pool.

You must use Amazon Web Services developer credentials to call this operation.

Examples:

Request syntax with placeholder values


resp = client.get_identity_pool_roles({
  identity_pool_id: "IdentityPoolId", # required
})

Response structure


resp.identity_pool_id #=> String
resp.roles #=> Hash
resp.roles["RoleType"] #=> String
resp.role_mappings #=> Hash
resp.role_mappings["IdentityProviderName"].type #=> String, one of "Token", "Rules"
resp.role_mappings["IdentityProviderName"].ambiguous_role_resolution #=> String, one of "AuthenticatedRole", "Deny"
resp.role_mappings["IdentityProviderName"].rules_configuration.rules #=> Array
resp.role_mappings["IdentityProviderName"].rules_configuration.rules[0].claim #=> String
resp.role_mappings["IdentityProviderName"].rules_configuration.rules[0].match_type #=> String, one of "Equals", "Contains", "StartsWith", "NotEqual"
resp.role_mappings["IdentityProviderName"].rules_configuration.rules[0].value #=> String
resp.role_mappings["IdentityProviderName"].rules_configuration.rules[0].role_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :identity_pool_id (required, String) —

    An identity pool ID in the format REGION:GUID.

Returns:

See Also:



939
940
941
942
 
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 939

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

#get_open_id_token(params = {}) ⇒ Types::GetOpenIdTokenResponse

Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by GetId. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link.

The OpenID token is valid for 10 minutes.

This is a public API. You do not need any credentials to call this API.

Examples:

Request syntax with placeholder values


resp = client.get_open_id_token({
  identity_id: "IdentityId", # required
  logins: {
    "IdentityProviderName" => "IdentityProviderToken",
  },
})

Response structure


resp.identity_id #=> String
resp.token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :identity_id (required, String) —

    A unique identifier in the format REGION:GUID.

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

    A set of optional name-value pairs that map provider names to provider tokens. When using graph.facebook.com and www.amazon.com, supply the access_token returned from the provider's authflow. For accounts.google.com, an Amazon Cognito user pool provider, or any other OpenID Connect provider, always include the id_token.

Returns:

See Also:



986
987
988
989
 
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 986

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

#get_open_id_token_for_developer_identity(params = {}) ⇒ Types::GetOpenIdTokenForDeveloperIdentityResponse

Registers (or retrieves) a Cognito IdentityId and an OpenID Connect token for a user authenticated by your backend authentication process. Supplying multiple logins will create an implicit linked account. You can only specify one developer provider as part of the Logins map, which is linked to the identity pool. The developer provider is the "domain" by which Cognito will refer to your users.

You can use GetOpenIdTokenForDeveloperIdentity to create a new identity and to link new logins (that is, user credentials issued by a public provider or developer provider) to an existing identity. When you want to create a new identity, the IdentityId should be null. When you want to associate a new login with an existing authenticated/unauthenticated identity, you can do so by providing the existing IdentityId. This API will create the identity in the specified IdentityPoolId.

You must use Amazon Web Services developer credentials to call this operation.

Examples:

Request syntax with placeholder values


resp = client.get_open_id_token_for_developer_identity({
  identity_pool_id: "IdentityPoolId", # required
  identity_id: "IdentityId",
  logins: { # required
    "IdentityProviderName" => "IdentityProviderToken",
  },
  principal_tags: {
    "PrincipalTagID" => "PrincipalTagValue",
  },
  token_duration: 1,
})

Response structure


resp.identity_id #=> String
resp.token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :identity_pool_id (required, String) —

    An identity pool ID in the format REGION:GUID.

  • :identity_id (String) —

    A unique identifier in the format REGION:GUID.

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

    A set of optional name-value pairs that map provider names to provider tokens. Each name-value pair represents a user from a public provider or developer provider. If the user is from a developer provider, the name-value pair will follow the syntax "developer_provider_name": "developer_user_identifier". The developer provider is the "domain" by which Cognito will refer to your users; you provided this domain while creating/updating the identity pool. The developer user identifier is an identifier from your backend that uniquely identifies a user. When you create an identity pool, you can specify the supported logins.

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

    Use this operation to configure attribute mappings for custom providers.

  • :token_duration (Integer) —

    The expiration time of the token, in seconds. You can specify a custom expiration time for the token so that you can cache it. If you don't provide an expiration time, the token is valid for 15 minutes. You can exchange the token with Amazon STS for temporary Amazon Web Services credentials, which are valid for a maximum of one hour. The maximum token duration you can set is 24 hours. You should take care in setting the expiration time for a token, as there are significant security implications: an attacker could use a leaked token to access your Amazon Web Services resources for the token's duration.

    Please provide for a small grace period, usually no more than 5 minutes, to account for clock skew.

Returns:

See Also:



1076
1077
1078
1079
 
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 1076

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

#get_principal_tag_attribute_map(params = {}) ⇒ Types::GetPrincipalTagAttributeMapResponse

Use GetPrincipalTagAttributeMap to list all mappings between PrincipalTags and user attributes.

Examples:

Request syntax with placeholder values


resp = client.get_principal_tag_attribute_map({
  identity_pool_id: "IdentityPoolId", # required
  identity_provider_name: "IdentityProviderName", # required
})

Response structure


resp.identity_pool_id #=> String
resp.identity_provider_name #=> String
resp.use_defaults #=> Boolean
resp.principal_tags #=> Hash
resp.principal_tags["PrincipalTagID"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :identity_pool_id (required, String) —

    You can use this operation to get the ID of the Identity Pool you setup attribute mappings for.

  • :identity_provider_name (required, String) —

    You can use this operation to get the provider name.

Returns:

See Also:



1117
1118
1119
1120
 
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 1117

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

#list_identities(params = {}) ⇒ Types::ListIdentitiesResponse

Lists the identities in an identity pool.

You must use Amazon Web Services developer credentials to call this operation.

Examples:

Request syntax with placeholder values


resp = client.list_identities({
  identity_pool_id: "IdentityPoolId", # required
  max_results: 1, # required
  next_token: "PaginationKey",
  hide_disabled: false,
})

Response structure


resp.identity_pool_id #=> String
resp.identities #=> Array
resp.identities[0].identity_id #=> String
resp.identities[0].logins #=> Array
resp.identities[0].logins[0] #=> String
resp.identities[0].creation_date #=> Time
resp.identities[0].last_modified_date #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :identity_pool_id (required, String) —

    An identity pool ID in the format REGION:GUID.

  • :max_results (required, Integer) —

    The maximum number of identities to return.

  • :next_token (String) —

    A pagination token.

  • :hide_disabled (Boolean) —

    An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.

Returns:

See Also:



1171
1172
1173
1174
 
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 1171

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

#list_identity_pools(params = {}) ⇒ Types::ListIdentityPoolsResponse

Lists all of the Cognito identity pools registered for your account.

You must use Amazon Web Services developer credentials to call this operation.

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_pools({
  max_results: 1, # required
  next_token: "PaginationKey",
})

Response structure


resp.identity_pools #=> Array
resp.identity_pools[0].identity_pool_id #=> String
resp.identity_pools[0].identity_pool_name #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (required, Integer) —

    The maximum number of identities to return.

  • :next_token (String) —

    A pagination token.

Returns:

See Also:



1212
1213
1214
1215
 
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 1212

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

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

Lists the tags that are assigned to an Amazon Cognito identity pool.

A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

You can use this action up to 10 times per second, per account.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the identity pool that the tags are assigned to.

Returns:

See Also:



1248
1249
1250
1251
 
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 1248

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

#lookup_developer_identity(params = {}) ⇒ Types::LookupDeveloperIdentityResponse

Retrieves the IdentityID associated with a DeveloperUserIdentifier or the list of DeveloperUserIdentifier values associated with an IdentityId for an existing identity. Either IdentityID or DeveloperUserIdentifier must not be null. If you supply only one of these values, the other value will be searched in the database and returned as a part of the response. If you supply both, DeveloperUserIdentifier will be matched against IdentityID. If the values are verified against the database, the response returns both values and is the same as the request. Otherwise, a ResourceConflictException is thrown.

LookupDeveloperIdentity is intended for low-throughput control plane operations: for example, to enable customer service to locate an identity ID by username. If you are using it for higher-volume operations such as user authentication, your requests are likely to be throttled. GetOpenIdTokenForDeveloperIdentity is a better option for higher-volume operations for user authentication.

You must use Amazon Web Services developer credentials to call this operation.

Examples:

Request syntax with placeholder values


resp = client.lookup_developer_identity({
  identity_pool_id: "IdentityPoolId", # required
  identity_id: "IdentityId",
  developer_user_identifier: "DeveloperUserIdentifier",
  max_results: 1,
  next_token: "PaginationKey",
})

Response structure


resp.identity_id #=> String
resp.developer_user_identifier_list #=> Array
resp.developer_user_identifier_list[0] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :identity_pool_id (required, String) —

    An identity pool ID in the format REGION:GUID.

  • :identity_id (String) —

    A unique identifier in the format REGION:GUID.

  • :developer_user_identifier (String) —

    A unique ID used by your backend authentication process to identify a user. Typically, a developer identity provider would issue many developer user identifiers, in keeping with the number of users.

  • :max_results (Integer) —

    The maximum number of identities to return.

  • :next_token (String) —

    A pagination token. The first call you make will have NextToken set to null. After that the service will return NextToken values as needed. For example, let's say you make a request with MaxResults set to 10, and there are 20 matches in the database. The service will return a pagination token as a part of the response. This token can be used to call the API again and get results starting from the 11th match.

Returns:

See Also:



1324
1325
1326
1327
 
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 1324

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

#merge_developer_identities(params = {}) ⇒ Types::MergeDeveloperIdentitiesResponse

Merges two users having different IdentityIds, existing in the same identity pool, and identified by the same developer provider. You can use this action to request that discrete users be merged and identified as a single user in the Cognito environment. Cognito associates the given source user (SourceUserIdentifier) with the IdentityId of the DestinationUserIdentifier. Only developer-authenticated users can be merged. If the users to be merged are associated with the same public provider, but as two different users, an exception will be thrown.

The number of linked logins is limited to 20. So, the number of linked logins for the source user, SourceUserIdentifier, and the destination user, DestinationUserIdentifier, together should not be larger than 20. Otherwise, an exception will be thrown.

You must use Amazon Web Services developer credentials to call this operation.

Examples:

Request syntax with placeholder values


resp = client.merge_developer_identities({
  source_user_identifier: "DeveloperUserIdentifier", # required
  destination_user_identifier: "DeveloperUserIdentifier", # required
  developer_provider_name: "DeveloperProviderName", # required
  identity_pool_id: "IdentityPoolId", # required
})

Response structure


resp.identity_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :source_user_identifier (required, String) —

    User identifier for the source user. The value should be a DeveloperUserIdentifier.

  • :destination_user_identifier (required, String) —

    User identifier for the destination user. The value should be a DeveloperUserIdentifier.

  • :developer_provider_name (required, String) —

    The "domain" by which Cognito will refer to your users. This is a (pseudo) domain name that you provide while creating an identity pool. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName, you can use letters as well as period (.), underscore (_), and dash (-).

  • :identity_pool_id (required, String) —

    An identity pool ID in the format REGION:GUID.

Returns:

See Also:



1387
1388
1389
1390
 
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 1387

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

#set_identity_pool_roles(params = {}) ⇒ Struct

Sets the roles for an identity pool. These roles are used when making calls to GetCredentialsForIdentity action.

You must use Amazon Web Services developer credentials to call this operation.

Examples:

Request syntax with placeholder values


resp = client.set_identity_pool_roles({
  identity_pool_id: "IdentityPoolId", # required
  roles: { # required
    "RoleType" => "ARNString",
  },
  role_mappings: {
    "IdentityProviderName" => {
      type: "Token", # required, accepts Token, Rules
      ambiguous_role_resolution: "AuthenticatedRole", # accepts AuthenticatedRole, Deny
      rules_configuration: {
        rules: [ # required
          {
            claim: "ClaimName", # required
            match_type: "Equals", # required, accepts Equals, Contains, StartsWith, NotEqual
            value: "ClaimValue", # required
            role_arn: "ARNString", # required
          },
        ],
      },
    },
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :identity_pool_id (required, String) —

    An identity pool ID in the format REGION:GUID.

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

    The map of roles associated with this pool. For a given role, the key will be either "authenticated" or "unauthenticated" and the value will be the Role ARN.

  • :role_mappings (Hash<String,Types::RoleMapping>) —

    How users for a specific identity provider are to mapped to roles. This is a string to RoleMapping object map. The string identifies the identity provider, for example, graph.facebook.com or cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id.

    Up to 25 rules can be specified per identity provider.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1445
1446
1447
1448
 
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 1445

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

#set_principal_tag_attribute_map(params = {}) ⇒ Types::SetPrincipalTagAttributeMapResponse

You can use this operation to use default (username and clientID) attribute or custom attribute mappings.

Examples:

Request syntax with placeholder values


resp = client.set_principal_tag_attribute_map({
  identity_pool_id: "IdentityPoolId", # required
  identity_provider_name: "IdentityProviderName", # required
  use_defaults: false,
  principal_tags: {
    "PrincipalTagID" => "PrincipalTagValue",
  },
})

Response structure


resp.identity_pool_id #=> String
resp.identity_provider_name #=> String
resp.use_defaults #=> Boolean
resp.principal_tags #=> Hash
resp.principal_tags["PrincipalTagID"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :identity_pool_id (required, String) —

    The ID of the Identity Pool you want to set attribute mappings for.

  • :identity_provider_name (required, String) —

    The provider name you want to use for attribute mappings.

  • :use_defaults (Boolean) —

    You can use this operation to use default (username and clientID) attribute mappings.

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

    You can use this operation to add principal tags.

Returns:

See Also:



1496
1497
1498
1499
 
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 1496

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

#tag_resource(params = {}) ⇒ Struct

Assigns a set of tags to the specified Amazon Cognito identity pool. A tag is a label that you can use to categorize and manage identity pools in different ways, such as by purpose, owner, environment, or other criteria.

Each tag consists of a key and value, both of which you define. A key is a general category for more specific values. For example, if you have two versions of an identity pool, one for testing and another for production, you might assign an Environment tag key to both identity pools. The value of this key might be Test for one identity pool and Production for the other.

Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your identity pools. In an IAM policy, you can constrain permissions for identity pools based on specific tags or tag values.

You can use this action up to 5 times per second, per account. An identity pool can have as many as 50 tags.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the identity pool.

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

    The tags to assign to the identity pool.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1543
1544
1545
1546
 
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 1543

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

#unlink_developer_identity(params = {}) ⇒ Struct

Unlinks a DeveloperUserIdentifier from an existing identity. Unlinked developer users will be considered new identities next time they are seen. If, for a given Cognito identity, you remove all federated identities as well as the developer user identifier, the Cognito identity becomes inaccessible.

You must use Amazon Web Services developer credentials to call this operation.

Examples:

Request syntax with placeholder values


resp = client.unlink_developer_identity({
  identity_id: "IdentityId", # required
  identity_pool_id: "IdentityPoolId", # required
  developer_provider_name: "DeveloperProviderName", # required
  developer_user_identifier: "DeveloperUserIdentifier", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :identity_id (required, String) —

    A unique identifier in the format REGION:GUID.

  • :identity_pool_id (required, String) —

    An identity pool ID in the format REGION:GUID.

  • :developer_provider_name (required, String) —

    The "domain" by which Cognito will refer to your users.

  • :developer_user_identifier (required, String) —

    A unique ID used by your backend authentication process to identify a user.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1585
1586
1587
1588
 
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 1585

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

#unlink_identity(params = {}) ⇒ Struct

Unlinks a federated identity from an existing account. Unlinked logins will be considered new identities next time they are seen. Removing the last linked login will make this identity inaccessible.

This is a public API. You do not need any credentials to call this API.

Examples:

Request syntax with placeholder values


resp = client.unlink_identity({
  identity_id: "IdentityId", # required
  logins: { # required
    "IdentityProviderName" => "IdentityProviderToken",
  },
  logins_to_remove: ["IdentityProviderName"], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :identity_id (required, String) —

    A unique identifier in the format REGION:GUID.

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

    A set of optional name-value pairs that map provider names to provider tokens.

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

    Provider names to unlink from this identity.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1623
1624
1625
1626
 
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 1623

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

#untag_resource(params = {}) ⇒ Struct

Removes the specified tags from the specified Amazon Cognito identity pool. You can use this action up to 5 times per second, per account

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the identity pool.

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

    The keys of the tags to remove from the user pool.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1650
1651
1652
1653
 
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 1650

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

#update_identity_pool(params = {}) ⇒ Types::IdentityPool

Updates the configuration of an identity pool.

If you don't provide a value for a parameter, Amazon Cognito sets it to its default value.

You must use Amazon Web Services developer credentials to call this operation.

Examples:

Request syntax with placeholder values


resp = client.update_identity_pool({
  identity_pool_id: "IdentityPoolId", # required
  identity_pool_name: "IdentityPoolName", # required
  allow_unauthenticated_identities: false, # required
  allow_classic_flow: false,
  supported_login_providers: {
    "IdentityProviderName" => "IdentityProviderId",
  },
  developer_provider_name: "DeveloperProviderName",
  open_id_connect_provider_arns: ["ARNString"],
  cognito_identity_providers: [
    {
      provider_name: "CognitoIdentityProviderName",
      client_id: "CognitoIdentityProviderClientId",
      server_side_token_check: false,
    },
  ],
  saml_provider_arns: ["ARNString"],
  identity_pool_tags: {
    "TagKeysType" => "TagValueType",
  },
})

Response structure


resp.identity_pool_id #=> String
resp.identity_pool_name #=> String
resp.allow_unauthenticated_identities #=> Boolean
resp.allow_classic_flow #=> Boolean
resp. #=> Hash
resp.["IdentityProviderName"] #=> String
resp.developer_provider_name #=> String
resp.open_id_connect_provider_arns #=> Array
resp.open_id_connect_provider_arns[0] #=> String
resp.cognito_identity_providers #=> Array
resp.cognito_identity_providers[0].provider_name #=> String
resp.cognito_identity_providers[0].client_id #=> String
resp.cognito_identity_providers[0].server_side_token_check #=> Boolean
resp.saml_provider_arns #=> Array
resp.saml_provider_arns[0] #=> String
resp.identity_pool_tags #=> Hash
resp.identity_pool_tags["TagKeysType"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :identity_pool_id (required, String) —

    An identity pool ID in the format REGION:GUID.

  • :identity_pool_name (required, String) —

    A string that you provide.

  • :allow_unauthenticated_identities (required, Boolean) —

    TRUE if the identity pool supports unauthenticated logins.

  • :allow_classic_flow (Boolean) —

    Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.

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

    Optional key:value pairs mapping provider names to provider app IDs.

  • :developer_provider_name (String) —

    The "domain" by which Cognito will refer to your users.

  • :open_id_connect_provider_arns (Array<String>) —

    The ARNs of the OpenID Connect providers.

  • :cognito_identity_providers (Array<Types::CognitoIdentityProvider>) —

    A list representing an Amazon Cognito user pool and its client ID.

  • :saml_provider_arns (Array<String>) —

    An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.

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

    The tags that are assigned to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

Returns:

See Also:



1765
1766
1767
1768
 
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/client.rb', line 1765

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