Class AWSCognitoIdentityProviderClient

java.lang.Object
com.amazonaws.AmazonWebServiceClient
com.amazonaws.services.cognitoidp.AWSCognitoIdentityProviderClient
All Implemented Interfaces:
AWSCognitoIdentityProvider
Direct Known Subclasses:
AWSCognitoIdentityProviderAsyncClient

@ThreadSafe public class AWSCognitoIdentityProviderClient extends AmazonWebServiceClient implements AWSCognitoIdentityProvider
Client for accessing Amazon Cognito Identity Provider. All service calls made using this client are blocking, and will not return until the service call completes.

You can create a user pool in Amazon Cognito Identity to manage directories and users. You can authenticate a user to obtain tokens related to user identity and access policies.

This API reference provides information about user pools in Amazon Cognito Identity, which is a new capability that is available as a beta.

  • Field Details

    • configFactory

      protected static final ClientConfigurationFactory configFactory
      Client configuration factory providing ClientConfigurations tailored to this client
  • Constructor Details

    • AWSCognitoIdentityProviderClient

      public AWSCognitoIdentityProviderClient()
      Constructs a new client to invoke service methods on Amazon Cognito Identity Provider. A credentials provider chain will be used that searches for credentials in this order:
      • Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
      • Java System Properties - aws.accessKeyId and aws.secretKey
      • Instance profile credentials delivered through the Amazon EC2 metadata service

      All service calls made using this new client object are blocking, and will not return until the service call completes.

      See Also:
    • AWSCognitoIdentityProviderClient

      public AWSCognitoIdentityProviderClient(ClientConfiguration clientConfiguration)
      Constructs a new client to invoke service methods on Amazon Cognito Identity Provider. A credentials provider chain will be used that searches for credentials in this order:
      • Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
      • Java System Properties - aws.accessKeyId and aws.secretKey
      • Instance profile credentials delivered through the Amazon EC2 metadata service

      All service calls made using this new client object are blocking, and will not return until the service call completes.

      Parameters:
      clientConfiguration - The client configuration options controlling how this client connects to Amazon Cognito Identity Provider (ex: proxy settings, retry counts, etc.).
      See Also:
    • AWSCognitoIdentityProviderClient

      public AWSCognitoIdentityProviderClient(AWSCredentials awsCredentials)
      Constructs a new client to invoke service methods on Amazon Cognito Identity Provider using the specified AWS account credentials.

      All service calls made using this new client object are blocking, and will not return until the service call completes.

      Parameters:
      awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
    • AWSCognitoIdentityProviderClient

      public AWSCognitoIdentityProviderClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
      Constructs a new client to invoke service methods on Amazon Cognito Identity Provider using the specified AWS account credentials and client configuration options.

      All service calls made using this new client object are blocking, and will not return until the service call completes.

      Parameters:
      awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
      clientConfiguration - The client configuration options controlling how this client connects to Amazon Cognito Identity Provider (ex: proxy settings, retry counts, etc.).
    • AWSCognitoIdentityProviderClient

      public AWSCognitoIdentityProviderClient(AWSCredentialsProvider awsCredentialsProvider)
      Constructs a new client to invoke service methods on Amazon Cognito Identity Provider using the specified AWS account credentials provider.

      All service calls made using this new client object are blocking, and will not return until the service call completes.

      Parameters:
      awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    • AWSCognitoIdentityProviderClient

      public AWSCognitoIdentityProviderClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
      Constructs a new client to invoke service methods on Amazon Cognito Identity Provider using the specified AWS account credentials provider and client configuration options.

      All service calls made using this new client object are blocking, and will not return until the service call completes.

      Parameters:
      awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
      clientConfiguration - The client configuration options controlling how this client connects to Amazon Cognito Identity Provider (ex: proxy settings, retry counts, etc.).
    • AWSCognitoIdentityProviderClient

      public AWSCognitoIdentityProviderClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
      Constructs a new client to invoke service methods on Amazon Cognito Identity Provider using the specified AWS account credentials provider, client configuration options, and request metric collector.

      All service calls made using this new client object are blocking, and will not return until the service call completes.

      Parameters:
      awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
      clientConfiguration - The client configuration options controlling how this client connects to Amazon Cognito Identity Provider (ex: proxy settings, retry counts, etc.).
      requestMetricCollector - optional request metric collector
  • Method Details