AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

CognitoIdentity

import "github.com/aws/aws-sdk-go/service/cognitoidentity"

type CognitoIdentity struct { *client.Client }

CognitoIdentity provides the API operation methods for making requests to Amazon Cognito Identity. See this package's package overview docs for details on the service.

CognitoIdentity methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

Client

Type: *client.Client

Method

CreateIdentityPool

func (c *CognitoIdentity) CreateIdentityPool(input *CreateIdentityPoolInput) (*IdentityPool, error)

CreateIdentityPool API operation for Amazon Cognito Identity.

Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account. The limit on identity pools is 60 per account. The keys for SupportedLoginProviders are as follows:

  • Facebook: graph.facebook.com

  • Google: accounts.google.com

  • Amazon: www.amazon.com

  • Twitter: api.twitter.com

  • Digits: www.digits.com

You must use AWS Developer credentials to call this API.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Identity's API operation CreateIdentityPool for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" Thrown for missing or bad input parameter(s).

  • ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.

  • ErrCodeResourceConflictException "ResourceConflictException" Thrown when a user tries to use a login which is already linked to another account.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown when a request is throttled.

  • ErrCodeInternalErrorException "InternalErrorException" Thrown when the service encounters an error during processing the request.

  • ErrCodeLimitExceededException "LimitExceededException" Thrown when the total number of user pools has exceeded a preset limit.

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/CreateIdentityPool

CreateIdentityPoolRequest

func (c *CognitoIdentity) CreateIdentityPoolRequest(input *CreateIdentityPoolInput) (req *request.Request, output *IdentityPool)

CreateIdentityPoolRequest generates a "aws/request.Request" representing the client's request for the CreateIdentityPool operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateIdentityPool for more information on using the CreateIdentityPool API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateIdentityPoolRequest method. req, resp := client.CreateIdentityPoolRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/CreateIdentityPool

CreateIdentityPoolWithContext

func (c *CognitoIdentity) CreateIdentityPoolWithContext(ctx aws.Context, input *CreateIdentityPoolInput, opts ...request.Option) (*IdentityPool, error)

CreateIdentityPoolWithContext is the same as CreateIdentityPool with the addition of the ability to pass a context and additional request options.

See CreateIdentityPool for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DeleteIdentities

func (c *CognitoIdentity) DeleteIdentities(input *DeleteIdentitiesInput) (*DeleteIdentitiesOutput, error)

DeleteIdentities API operation for Amazon Cognito Identity.

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

You must use AWS Developer credentials to call this API.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Identity's API operation DeleteIdentities for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" Thrown for missing or bad input parameter(s).

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown when a request is throttled.

  • ErrCodeInternalErrorException "InternalErrorException" Thrown when the service encounters an error during processing the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/DeleteIdentities

DeleteIdentitiesRequest

func (c *CognitoIdentity) DeleteIdentitiesRequest(input *DeleteIdentitiesInput) (req *request.Request, output *DeleteIdentitiesOutput)

DeleteIdentitiesRequest generates a "aws/request.Request" representing the client's request for the DeleteIdentities operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteIdentities for more information on using the DeleteIdentities API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteIdentitiesRequest method. req, resp := client.DeleteIdentitiesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/DeleteIdentities

DeleteIdentitiesWithContext

func (c *CognitoIdentity) DeleteIdentitiesWithContext(ctx aws.Context, input *DeleteIdentitiesInput, opts ...request.Option) (*DeleteIdentitiesOutput, error)

DeleteIdentitiesWithContext is the same as DeleteIdentities with the addition of the ability to pass a context and additional request options.

See DeleteIdentities for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DeleteIdentityPool

func (c *CognitoIdentity) DeleteIdentityPool(input *DeleteIdentityPoolInput) (*DeleteIdentityPoolOutput, error)

DeleteIdentityPool API operation for Amazon Cognito Identity.

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

You must use AWS Developer credentials to call this API.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Identity's API operation DeleteIdentityPool for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" Thrown for missing or bad input parameter(s).

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown when the requested resource (for example, a dataset or record) does not exist.

  • ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown when a request is throttled.

  • ErrCodeInternalErrorException "InternalErrorException" Thrown when the service encounters an error during processing the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/DeleteIdentityPool

DeleteIdentityPoolRequest

func (c *CognitoIdentity) DeleteIdentityPoolRequest(input *DeleteIdentityPoolInput) (req *request.Request, output *DeleteIdentityPoolOutput)

DeleteIdentityPoolRequest generates a "aws/request.Request" representing the client's request for the DeleteIdentityPool operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteIdentityPool for more information on using the DeleteIdentityPool API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteIdentityPoolRequest method. req, resp := client.DeleteIdentityPoolRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/DeleteIdentityPool

DeleteIdentityPoolWithContext

func (c *CognitoIdentity) DeleteIdentityPoolWithContext(ctx aws.Context, input *DeleteIdentityPoolInput, opts ...request.Option) (*DeleteIdentityPoolOutput, error)

DeleteIdentityPoolWithContext is the same as DeleteIdentityPool with the addition of the ability to pass a context and additional request options.

See DeleteIdentityPool for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DescribeIdentity

func (c *CognitoIdentity) DescribeIdentity(input *DescribeIdentityInput) (*IdentityDescription, error)

DescribeIdentity API operation for Amazon Cognito Identity.

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

You must use AWS Developer credentials to call this API.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Identity's API operation DescribeIdentity for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" Thrown for missing or bad input parameter(s).

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown when the requested resource (for example, a dataset or record) does not exist.

  • ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown when a request is throttled.

  • ErrCodeInternalErrorException "InternalErrorException" Thrown when the service encounters an error during processing the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/DescribeIdentity

DescribeIdentityPool

func (c *CognitoIdentity) DescribeIdentityPool(input *DescribeIdentityPoolInput) (*IdentityPool, error)

DescribeIdentityPool API operation for Amazon Cognito Identity.

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

You must use AWS Developer credentials to call this API.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Identity's API operation DescribeIdentityPool for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" Thrown for missing or bad input parameter(s).

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown when the requested resource (for example, a dataset or record) does not exist.

  • ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown when a request is throttled.

  • ErrCodeInternalErrorException "InternalErrorException" Thrown when the service encounters an error during processing the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/DescribeIdentityPool

DescribeIdentityPoolRequest

func (c *CognitoIdentity) DescribeIdentityPoolRequest(input *DescribeIdentityPoolInput) (req *request.Request, output *IdentityPool)

DescribeIdentityPoolRequest generates a "aws/request.Request" representing the client's request for the DescribeIdentityPool operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeIdentityPool for more information on using the DescribeIdentityPool API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeIdentityPoolRequest method. req, resp := client.DescribeIdentityPoolRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/DescribeIdentityPool

DescribeIdentityPoolWithContext

func (c *CognitoIdentity) DescribeIdentityPoolWithContext(ctx aws.Context, input *DescribeIdentityPoolInput, opts ...request.Option) (*IdentityPool, error)

DescribeIdentityPoolWithContext is the same as DescribeIdentityPool with the addition of the ability to pass a context and additional request options.

See DescribeIdentityPool for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DescribeIdentityRequest

func (c *CognitoIdentity) DescribeIdentityRequest(input *DescribeIdentityInput) (req *request.Request, output *IdentityDescription)

DescribeIdentityRequest generates a "aws/request.Request" representing the client's request for the DescribeIdentity operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeIdentity for more information on using the DescribeIdentity API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeIdentityRequest method. req, resp := client.DescribeIdentityRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/DescribeIdentity

DescribeIdentityWithContext

func (c *CognitoIdentity) DescribeIdentityWithContext(ctx aws.Context, input *DescribeIdentityInput, opts ...request.Option) (*IdentityDescription, error)

DescribeIdentityWithContext is the same as DescribeIdentity with the addition of the ability to pass a context and additional request options.

See DescribeIdentity for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetCredentialsForIdentity

func (c *CognitoIdentity) GetCredentialsForIdentity(input *GetCredentialsForIdentityInput) (*GetCredentialsForIdentityOutput, error)

GetCredentialsForIdentity API operation for Amazon Cognito Identity.

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 AWS 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Identity's API operation GetCredentialsForIdentity for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" Thrown for missing or bad input parameter(s).

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown when the requested resource (for example, a dataset or record) does not exist.

  • ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.

  • ErrCodeResourceConflictException "ResourceConflictException" Thrown when a user tries to use a login which is already linked to another account.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown when a request is throttled.

  • ErrCodeInvalidIdentityPoolConfigurationException "InvalidIdentityPoolConfigurationException" Thrown if the identity pool has no role associated for the given auth type

(auth/unauth) or if the AssumeRole fails.
  • ErrCodeInternalErrorException "InternalErrorException" Thrown when the service encounters an error during processing the request.

  • ErrCodeExternalServiceException "ExternalServiceException" An exception thrown when a dependent service such as Facebook or Twitter is not responding

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/GetCredentialsForIdentity

GetCredentialsForIdentityRequest

func (c *CognitoIdentity) GetCredentialsForIdentityRequest(input *GetCredentialsForIdentityInput) (req *request.Request, output *GetCredentialsForIdentityOutput)

GetCredentialsForIdentityRequest generates a "aws/request.Request" representing the client's request for the GetCredentialsForIdentity operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetCredentialsForIdentity for more information on using the GetCredentialsForIdentity API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetCredentialsForIdentityRequest method. req, resp := client.GetCredentialsForIdentityRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/GetCredentialsForIdentity

GetCredentialsForIdentityWithContext

func (c *CognitoIdentity) GetCredentialsForIdentityWithContext(ctx aws.Context, input *GetCredentialsForIdentityInput, opts ...request.Option) (*GetCredentialsForIdentityOutput, error)

GetCredentialsForIdentityWithContext is the same as GetCredentialsForIdentity with the addition of the ability to pass a context and additional request options.

See GetCredentialsForIdentity for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetId

func (c *CognitoIdentity) GetId(input *GetIdInput) (*GetIdOutput, error)

GetId API operation for Amazon Cognito Identity.

Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Identity's API operation GetId for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" Thrown for missing or bad input parameter(s).

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown when the requested resource (for example, a dataset or record) does not exist.

  • ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.

  • ErrCodeResourceConflictException "ResourceConflictException" Thrown when a user tries to use a login which is already linked to another account.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown when a request is throttled.

  • ErrCodeInternalErrorException "InternalErrorException" Thrown when the service encounters an error during processing the request.

  • ErrCodeLimitExceededException "LimitExceededException" Thrown when the total number of user pools has exceeded a preset limit.

  • ErrCodeExternalServiceException "ExternalServiceException" An exception thrown when a dependent service such as Facebook or Twitter is not responding

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/GetId

GetIdRequest

func (c *CognitoIdentity) GetIdRequest(input *GetIdInput) (req *request.Request, output *GetIdOutput)

GetIdRequest generates a "aws/request.Request" representing the client's request for the GetId operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetId for more information on using the GetId API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetIdRequest method. req, resp := client.GetIdRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/GetId

GetIdWithContext

func (c *CognitoIdentity) GetIdWithContext(ctx aws.Context, input *GetIdInput, opts ...request.Option) (*GetIdOutput, error)

GetIdWithContext is the same as GetId with the addition of the ability to pass a context and additional request options.

See GetId for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetIdentityPoolRoles

func (c *CognitoIdentity) GetIdentityPoolRoles(input *GetIdentityPoolRolesInput) (*GetIdentityPoolRolesOutput, error)

GetIdentityPoolRoles API operation for Amazon Cognito Identity.

Gets the roles for an identity pool.

You must use AWS Developer credentials to call this API.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Identity's API operation GetIdentityPoolRoles for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" Thrown for missing or bad input parameter(s).

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown when the requested resource (for example, a dataset or record) does not exist.

  • ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.

  • ErrCodeResourceConflictException "ResourceConflictException" Thrown when a user tries to use a login which is already linked to another account.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown when a request is throttled.

  • ErrCodeInternalErrorException "InternalErrorException" Thrown when the service encounters an error during processing the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/GetIdentityPoolRoles

GetIdentityPoolRolesRequest

func (c *CognitoIdentity) GetIdentityPoolRolesRequest(input *GetIdentityPoolRolesInput) (req *request.Request, output *GetIdentityPoolRolesOutput)

GetIdentityPoolRolesRequest generates a "aws/request.Request" representing the client's request for the GetIdentityPoolRoles operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetIdentityPoolRoles for more information on using the GetIdentityPoolRoles API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetIdentityPoolRolesRequest method. req, resp := client.GetIdentityPoolRolesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/GetIdentityPoolRoles

GetIdentityPoolRolesWithContext

func (c *CognitoIdentity) GetIdentityPoolRolesWithContext(ctx aws.Context, input *GetIdentityPoolRolesInput, opts ...request.Option) (*GetIdentityPoolRolesOutput, error)

GetIdentityPoolRolesWithContext is the same as GetIdentityPoolRoles with the addition of the ability to pass a context and additional request options.

See GetIdentityPoolRoles for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetOpenIdToken

func (c *CognitoIdentity) GetOpenIdToken(input *GetOpenIdTokenInput) (*GetOpenIdTokenOutput, error)

GetOpenIdToken API operation for Amazon Cognito Identity.

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 15 minutes.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Identity's API operation GetOpenIdToken for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" Thrown for missing or bad input parameter(s).

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown when the requested resource (for example, a dataset or record) does not exist.

  • ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.

  • ErrCodeResourceConflictException "ResourceConflictException" Thrown when a user tries to use a login which is already linked to another account.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown when a request is throttled.

  • ErrCodeInternalErrorException "InternalErrorException" Thrown when the service encounters an error during processing the request.

  • ErrCodeExternalServiceException "ExternalServiceException" An exception thrown when a dependent service such as Facebook or Twitter is not responding

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/GetOpenIdToken

GetOpenIdTokenForDeveloperIdentity

func (c *CognitoIdentity) GetOpenIdTokenForDeveloperIdentity(input *GetOpenIdTokenForDeveloperIdentityInput) (*GetOpenIdTokenForDeveloperIdentityOutput, error)

GetOpenIdTokenForDeveloperIdentity API operation for Amazon Cognito Identity.

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 AWS Developer credentials to call this API.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Identity's API operation GetOpenIdTokenForDeveloperIdentity for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" Thrown for missing or bad input parameter(s).

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown when the requested resource (for example, a dataset or record) does not exist.

  • ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.

  • ErrCodeResourceConflictException "ResourceConflictException" Thrown when a user tries to use a login which is already linked to another account.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown when a request is throttled.

  • ErrCodeInternalErrorException "InternalErrorException" Thrown when the service encounters an error during processing the request.

  • ErrCodeDeveloperUserAlreadyRegisteredException "DeveloperUserAlreadyRegisteredException" The provided developer user identifier is already registered with Cognito under a different identity ID.

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/GetOpenIdTokenForDeveloperIdentity

GetOpenIdTokenForDeveloperIdentityRequest

func (c *CognitoIdentity) GetOpenIdTokenForDeveloperIdentityRequest(input *GetOpenIdTokenForDeveloperIdentityInput) (req *request.Request, output *GetOpenIdTokenForDeveloperIdentityOutput)

GetOpenIdTokenForDeveloperIdentityRequest generates a "aws/request.Request" representing the client's request for the GetOpenIdTokenForDeveloperIdentity operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetOpenIdTokenForDeveloperIdentity for more information on using the GetOpenIdTokenForDeveloperIdentity API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetOpenIdTokenForDeveloperIdentityRequest method. req, resp := client.GetOpenIdTokenForDeveloperIdentityRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/GetOpenIdTokenForDeveloperIdentity

GetOpenIdTokenForDeveloperIdentityWithContext

func (c *CognitoIdentity) GetOpenIdTokenForDeveloperIdentityWithContext(ctx aws.Context, input *GetOpenIdTokenForDeveloperIdentityInput, opts ...request.Option) (*GetOpenIdTokenForDeveloperIdentityOutput, error)

GetOpenIdTokenForDeveloperIdentityWithContext is the same as GetOpenIdTokenForDeveloperIdentity with the addition of the ability to pass a context and additional request options.

See GetOpenIdTokenForDeveloperIdentity for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetOpenIdTokenRequest

func (c *CognitoIdentity) GetOpenIdTokenRequest(input *GetOpenIdTokenInput) (req *request.Request, output *GetOpenIdTokenOutput)

GetOpenIdTokenRequest generates a "aws/request.Request" representing the client's request for the GetOpenIdToken operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetOpenIdToken for more information on using the GetOpenIdToken API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetOpenIdTokenRequest method. req, resp := client.GetOpenIdTokenRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/GetOpenIdToken

GetOpenIdTokenWithContext

func (c *CognitoIdentity) GetOpenIdTokenWithContext(ctx aws.Context, input *GetOpenIdTokenInput, opts ...request.Option) (*GetOpenIdTokenOutput, error)

GetOpenIdTokenWithContext is the same as GetOpenIdToken with the addition of the ability to pass a context and additional request options.

See GetOpenIdToken for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

ListIdentities

func (c *CognitoIdentity) ListIdentities(input *ListIdentitiesInput) (*ListIdentitiesOutput, error)

ListIdentities API operation for Amazon Cognito Identity.

Lists the identities in a pool.

You must use AWS Developer credentials to call this API.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Identity's API operation ListIdentities for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" Thrown for missing or bad input parameter(s).

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown when the requested resource (for example, a dataset or record) does not exist.

  • ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown when a request is throttled.

  • ErrCodeInternalErrorException "InternalErrorException" Thrown when the service encounters an error during processing the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/ListIdentities

ListIdentitiesRequest

func (c *CognitoIdentity) ListIdentitiesRequest(input *ListIdentitiesInput) (req *request.Request, output *ListIdentitiesOutput)

ListIdentitiesRequest generates a "aws/request.Request" representing the client's request for the ListIdentities operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListIdentities for more information on using the ListIdentities API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListIdentitiesRequest method. req, resp := client.ListIdentitiesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/ListIdentities

ListIdentitiesWithContext

func (c *CognitoIdentity) ListIdentitiesWithContext(ctx aws.Context, input *ListIdentitiesInput, opts ...request.Option) (*ListIdentitiesOutput, error)

ListIdentitiesWithContext is the same as ListIdentities with the addition of the ability to pass a context and additional request options.

See ListIdentities for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

ListIdentityPools

func (c *CognitoIdentity) ListIdentityPools(input *ListIdentityPoolsInput) (*ListIdentityPoolsOutput, error)

ListIdentityPools API operation for Amazon Cognito Identity.

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

You must use AWS Developer credentials to call this API.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Identity's API operation ListIdentityPools for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" Thrown for missing or bad input parameter(s).

  • ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown when a request is throttled.

  • ErrCodeInternalErrorException "InternalErrorException" Thrown when the service encounters an error during processing the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/ListIdentityPools

ListIdentityPoolsRequest

func (c *CognitoIdentity) ListIdentityPoolsRequest(input *ListIdentityPoolsInput) (req *request.Request, output *ListIdentityPoolsOutput)

ListIdentityPoolsRequest generates a "aws/request.Request" representing the client's request for the ListIdentityPools operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListIdentityPools for more information on using the ListIdentityPools API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListIdentityPoolsRequest method. req, resp := client.ListIdentityPoolsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/ListIdentityPools

ListIdentityPoolsWithContext

func (c *CognitoIdentity) ListIdentityPoolsWithContext(ctx aws.Context, input *ListIdentityPoolsInput, opts ...request.Option) (*ListIdentityPoolsOutput, error)

ListIdentityPoolsWithContext is the same as ListIdentityPools with the addition of the ability to pass a context and additional request options.

See ListIdentityPools for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

LookupDeveloperIdentity

func (c *CognitoIdentity) LookupDeveloperIdentity(input *LookupDeveloperIdentityInput) (*LookupDeveloperIdentityOutput, error)

LookupDeveloperIdentity API operation for Amazon Cognito Identity.

Retrieves the IdentityID associated with a DeveloperUserIdentifier or the list of DeveloperUserIdentifiers 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.

You must use AWS Developer credentials to call this API.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Identity's API operation LookupDeveloperIdentity for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" Thrown for missing or bad input parameter(s).

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown when the requested resource (for example, a dataset or record) does not exist.

  • ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.

  • ErrCodeResourceConflictException "ResourceConflictException" Thrown when a user tries to use a login which is already linked to another account.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown when a request is throttled.

  • ErrCodeInternalErrorException "InternalErrorException" Thrown when the service encounters an error during processing the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/LookupDeveloperIdentity

LookupDeveloperIdentityRequest

func (c *CognitoIdentity) LookupDeveloperIdentityRequest(input *LookupDeveloperIdentityInput) (req *request.Request, output *LookupDeveloperIdentityOutput)

LookupDeveloperIdentityRequest generates a "aws/request.Request" representing the client's request for the LookupDeveloperIdentity operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See LookupDeveloperIdentity for more information on using the LookupDeveloperIdentity API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the LookupDeveloperIdentityRequest method. req, resp := client.LookupDeveloperIdentityRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/LookupDeveloperIdentity

LookupDeveloperIdentityWithContext

func (c *CognitoIdentity) LookupDeveloperIdentityWithContext(ctx aws.Context, input *LookupDeveloperIdentityInput, opts ...request.Option) (*LookupDeveloperIdentityOutput, error)

LookupDeveloperIdentityWithContext is the same as LookupDeveloperIdentity with the addition of the ability to pass a context and additional request options.

See LookupDeveloperIdentity for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

MergeDeveloperIdentities

func (c *CognitoIdentity) MergeDeveloperIdentities(input *MergeDeveloperIdentitiesInput) (*MergeDeveloperIdentitiesOutput, error)

MergeDeveloperIdentities API operation for Amazon Cognito Identity.

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.

You must use AWS Developer credentials to call this API.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Identity's API operation MergeDeveloperIdentities for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" Thrown for missing or bad input parameter(s).

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown when the requested resource (for example, a dataset or record) does not exist.

  • ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.

  • ErrCodeResourceConflictException "ResourceConflictException" Thrown when a user tries to use a login which is already linked to another account.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown when a request is throttled.

  • ErrCodeInternalErrorException "InternalErrorException" Thrown when the service encounters an error during processing the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/MergeDeveloperIdentities

MergeDeveloperIdentitiesRequest

func (c *CognitoIdentity) MergeDeveloperIdentitiesRequest(input *MergeDeveloperIdentitiesInput) (req *request.Request, output *MergeDeveloperIdentitiesOutput)

MergeDeveloperIdentitiesRequest generates a "aws/request.Request" representing the client's request for the MergeDeveloperIdentities operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See MergeDeveloperIdentities for more information on using the MergeDeveloperIdentities API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the MergeDeveloperIdentitiesRequest method. req, resp := client.MergeDeveloperIdentitiesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/MergeDeveloperIdentities

MergeDeveloperIdentitiesWithContext

func (c *CognitoIdentity) MergeDeveloperIdentitiesWithContext(ctx aws.Context, input *MergeDeveloperIdentitiesInput, opts ...request.Option) (*MergeDeveloperIdentitiesOutput, error)

MergeDeveloperIdentitiesWithContext is the same as MergeDeveloperIdentities with the addition of the ability to pass a context and additional request options.

See MergeDeveloperIdentities for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

SetIdentityPoolRoles

func (c *CognitoIdentity) SetIdentityPoolRoles(input *SetIdentityPoolRolesInput) (*SetIdentityPoolRolesOutput, error)

SetIdentityPoolRoles API operation for Amazon Cognito Identity.

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

You must use AWS Developer credentials to call this API.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Identity's API operation SetIdentityPoolRoles for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" Thrown for missing or bad input parameter(s).

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown when the requested resource (for example, a dataset or record) does not exist.

  • ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.

  • ErrCodeResourceConflictException "ResourceConflictException" Thrown when a user tries to use a login which is already linked to another account.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown when a request is throttled.

  • ErrCodeInternalErrorException "InternalErrorException" Thrown when the service encounters an error during processing the request.

  • ErrCodeConcurrentModificationException "ConcurrentModificationException" Thrown if there are parallel requests to modify a resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/SetIdentityPoolRoles

SetIdentityPoolRolesRequest

func (c *CognitoIdentity) SetIdentityPoolRolesRequest(input *SetIdentityPoolRolesInput) (req *request.Request, output *SetIdentityPoolRolesOutput)

SetIdentityPoolRolesRequest generates a "aws/request.Request" representing the client's request for the SetIdentityPoolRoles operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SetIdentityPoolRoles for more information on using the SetIdentityPoolRoles API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the SetIdentityPoolRolesRequest method. req, resp := client.SetIdentityPoolRolesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/SetIdentityPoolRoles

SetIdentityPoolRolesWithContext

func (c *CognitoIdentity) SetIdentityPoolRolesWithContext(ctx aws.Context, input *SetIdentityPoolRolesInput, opts ...request.Option) (*SetIdentityPoolRolesOutput, error)

SetIdentityPoolRolesWithContext is the same as SetIdentityPoolRoles with the addition of the ability to pass a context and additional request options.

See SetIdentityPoolRoles for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

UnlinkDeveloperIdentity

func (c *CognitoIdentity) UnlinkDeveloperIdentity(input *UnlinkDeveloperIdentityInput) (*UnlinkDeveloperIdentityOutput, error)

UnlinkDeveloperIdentity API operation for Amazon Cognito Identity.

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 AWS Developer credentials to call this API.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Identity's API operation UnlinkDeveloperIdentity for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" Thrown for missing or bad input parameter(s).

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown when the requested resource (for example, a dataset or record) does not exist.

  • ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.

  • ErrCodeResourceConflictException "ResourceConflictException" Thrown when a user tries to use a login which is already linked to another account.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown when a request is throttled.

  • ErrCodeInternalErrorException "InternalErrorException" Thrown when the service encounters an error during processing the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/UnlinkDeveloperIdentity

UnlinkDeveloperIdentityRequest

func (c *CognitoIdentity) UnlinkDeveloperIdentityRequest(input *UnlinkDeveloperIdentityInput) (req *request.Request, output *UnlinkDeveloperIdentityOutput)

UnlinkDeveloperIdentityRequest generates a "aws/request.Request" representing the client's request for the UnlinkDeveloperIdentity operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UnlinkDeveloperIdentity for more information on using the UnlinkDeveloperIdentity API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UnlinkDeveloperIdentityRequest method. req, resp := client.UnlinkDeveloperIdentityRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/UnlinkDeveloperIdentity

UnlinkDeveloperIdentityWithContext

func (c *CognitoIdentity) UnlinkDeveloperIdentityWithContext(ctx aws.Context, input *UnlinkDeveloperIdentityInput, opts ...request.Option) (*UnlinkDeveloperIdentityOutput, error)

UnlinkDeveloperIdentityWithContext is the same as UnlinkDeveloperIdentity with the addition of the ability to pass a context and additional request options.

See UnlinkDeveloperIdentity for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

UnlinkIdentity

func (c *CognitoIdentity) UnlinkIdentity(input *UnlinkIdentityInput) (*UnlinkIdentityOutput, error)

UnlinkIdentity API operation for Amazon Cognito Identity.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Identity's API operation UnlinkIdentity for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" Thrown for missing or bad input parameter(s).

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown when the requested resource (for example, a dataset or record) does not exist.

  • ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.

  • ErrCodeResourceConflictException "ResourceConflictException" Thrown when a user tries to use a login which is already linked to another account.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown when a request is throttled.

  • ErrCodeInternalErrorException "InternalErrorException" Thrown when the service encounters an error during processing the request.

  • ErrCodeExternalServiceException "ExternalServiceException" An exception thrown when a dependent service such as Facebook or Twitter is not responding

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/UnlinkIdentity

UnlinkIdentityRequest

func (c *CognitoIdentity) UnlinkIdentityRequest(input *UnlinkIdentityInput) (req *request.Request, output *UnlinkIdentityOutput)

UnlinkIdentityRequest generates a "aws/request.Request" representing the client's request for the UnlinkIdentity operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UnlinkIdentity for more information on using the UnlinkIdentity API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UnlinkIdentityRequest method. req, resp := client.UnlinkIdentityRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/UnlinkIdentity

UnlinkIdentityWithContext

func (c *CognitoIdentity) UnlinkIdentityWithContext(ctx aws.Context, input *UnlinkIdentityInput, opts ...request.Option) (*UnlinkIdentityOutput, error)

UnlinkIdentityWithContext is the same as UnlinkIdentity with the addition of the ability to pass a context and additional request options.

See UnlinkIdentity for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

UpdateIdentityPool

func (c *CognitoIdentity) UpdateIdentityPool(input *IdentityPool) (*IdentityPool, error)

UpdateIdentityPool API operation for Amazon Cognito Identity.

Updates a user pool.

You must use AWS Developer credentials to call this API.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Identity's API operation UpdateIdentityPool for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" Thrown for missing or bad input parameter(s).

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown when the requested resource (for example, a dataset or record) does not exist.

  • ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.

  • ErrCodeResourceConflictException "ResourceConflictException" Thrown when a user tries to use a login which is already linked to another account.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown when a request is throttled.

  • ErrCodeInternalErrorException "InternalErrorException" Thrown when the service encounters an error during processing the request.

  • ErrCodeConcurrentModificationException "ConcurrentModificationException" Thrown if there are parallel requests to modify a resource.

  • ErrCodeLimitExceededException "LimitExceededException" Thrown when the total number of user pools has exceeded a preset limit.

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/UpdateIdentityPool

UpdateIdentityPoolRequest

func (c *CognitoIdentity) UpdateIdentityPoolRequest(input *IdentityPool) (req *request.Request, output *IdentityPool)

UpdateIdentityPoolRequest generates a "aws/request.Request" representing the client's request for the UpdateIdentityPool operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateIdentityPool for more information on using the UpdateIdentityPool API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateIdentityPoolRequest method. req, resp := client.UpdateIdentityPoolRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/UpdateIdentityPool

UpdateIdentityPoolWithContext

func (c *CognitoIdentity) UpdateIdentityPoolWithContext(ctx aws.Context, input *IdentityPool, opts ...request.Option) (*IdentityPool, error)

UpdateIdentityPoolWithContext is the same as UpdateIdentityPool with the addition of the ability to pass a context and additional request options.

See UpdateIdentityPool for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

On this page: