cognitoidentity

package
v1.54.8 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 25, 2024 License: Apache-2.0 Imports: 11 Imported by: 185

Documentation

Overview

Package cognitoidentity provides the client and types for making API requests to Amazon Cognito Identity.

Amazon Cognito Federated Identities is a web service that delivers scoped temporary credentials to mobile devices and other untrusted environments. It uniquely identifies a device and supplies the user with a consistent identity over the lifetime of an application.

Using Amazon Cognito Federated Identities, you can enable authentication with one or more third-party identity providers (Facebook, Google, or Login with Amazon) or an Amazon Cognito user pool, and you can also choose to support unauthenticated access from your app. Cognito delivers a unique identifier for each user and acts as an OpenID token provider trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS credentials.

For a description of the authentication flow from the Amazon Cognito Developer Guide see Authentication Flow (https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html).

For more information see Amazon Cognito Federated Identities (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-identity.html).

See https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30 for more information on this service.

See cognitoidentity package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/cognitoidentity/

Using the Client

To contact Amazon Cognito Identity with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon Cognito Identity client CognitoIdentity for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/cognitoidentity/#New

Index

Constants

View Source 
const (
	// AmbiguousRoleResolutionTypeAuthenticatedRole is a AmbiguousRoleResolutionType enum value
	AmbiguousRoleResolutionTypeAuthenticatedRole = "AuthenticatedRole"

	// AmbiguousRoleResolutionTypeDeny is a AmbiguousRoleResolutionType enum value
	AmbiguousRoleResolutionTypeDeny = "Deny"
)
View Source 
const (
	// ErrorCodeAccessDenied is a ErrorCode enum value
	ErrorCodeAccessDenied = "AccessDenied"

	// ErrorCodeInternalServerError is a ErrorCode enum value
	ErrorCodeInternalServerError = "InternalServerError"
)
View Source 
const (
	// MappingRuleMatchTypeEquals is a MappingRuleMatchType enum value
	MappingRuleMatchTypeEquals = "Equals"

	// MappingRuleMatchTypeContains is a MappingRuleMatchType enum value
	MappingRuleMatchTypeContains = "Contains"

	// MappingRuleMatchTypeStartsWith is a MappingRuleMatchType enum value
	MappingRuleMatchTypeStartsWith = "StartsWith"

	// MappingRuleMatchTypeNotEqual is a MappingRuleMatchType enum value
	MappingRuleMatchTypeNotEqual = "NotEqual"
)
View Source 
const (
	// RoleMappingTypeToken is a RoleMappingType enum value
	RoleMappingTypeToken = "Token"

	// RoleMappingTypeRules is a RoleMappingType enum value
	RoleMappingTypeRules = "Rules"
)
View Source 
const (

	// ErrCodeConcurrentModificationException for service response error code
	// "ConcurrentModificationException".
	//
	// Thrown if there are parallel requests to modify a resource.
	ErrCodeConcurrentModificationException = "ConcurrentModificationException"

	// ErrCodeDeveloperUserAlreadyRegisteredException for service response error code
	// "DeveloperUserAlreadyRegisteredException".
	//
	// The provided developer user identifier is already registered with Cognito
	// under a different identity ID.
	ErrCodeDeveloperUserAlreadyRegisteredException = "DeveloperUserAlreadyRegisteredException"

	// ErrCodeExternalServiceException for service response error code
	// "ExternalServiceException".
	//
	// An exception thrown when a dependent service such as Facebook or Twitter
	// is not responding
	ErrCodeExternalServiceException = "ExternalServiceException"

	// ErrCodeInternalErrorException for service response error code
	// "InternalErrorException".
	//
	// Thrown when the service encounters an error during processing the request.
	ErrCodeInternalErrorException = "InternalErrorException"

	// ErrCodeInvalidIdentityPoolConfigurationException for service response error code
	// "InvalidIdentityPoolConfigurationException".
	//
	// Thrown if the identity pool has no role associated for the given auth type
	// (auth/unauth) or if the AssumeRole fails.
	ErrCodeInvalidIdentityPoolConfigurationException = "InvalidIdentityPoolConfigurationException"

	// ErrCodeInvalidParameterException for service response error code
	// "InvalidParameterException".
	//
	// Thrown for missing or bad input parameter(s).
	ErrCodeInvalidParameterException = "InvalidParameterException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// Thrown when the total number of user pools has exceeded a preset limit.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeNotAuthorizedException for service response error code
	// "NotAuthorizedException".
	//
	// Thrown when a user is not authorized to access the requested resource.
	ErrCodeNotAuthorizedException = "NotAuthorizedException"

	// ErrCodeResourceConflictException for service response error code
	// "ResourceConflictException".
	//
	// Thrown when a user tries to use a login which is already linked to another
	// account.
	ErrCodeResourceConflictException = "ResourceConflictException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// Thrown when the requested resource (for example, a dataset or record) does
	// not exist.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeTooManyRequestsException for service response error code
	// "TooManyRequestsException".
	//
	// Thrown when a request is throttled.
	ErrCodeTooManyRequestsException = "TooManyRequestsException"
)
View Source 
const (
	ServiceName = "cognito-identity" // Name of service.
	EndpointsID = ServiceName        // ID to lookup a service endpoint with.
	ServiceID   = "Cognito Identity" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func AmbiguousRoleResolutionType_Values added in v1.34.3 

func AmbiguousRoleResolutionType_Values() []string

AmbiguousRoleResolutionType_Values returns all elements of the AmbiguousRoleResolutionType enum

func ErrorCode_Values added in v1.34.3 

func ErrorCode_Values() []string

ErrorCode_Values returns all elements of the ErrorCode enum

func MappingRuleMatchType_Values added in v1.34.3 

func MappingRuleMatchType_Values() []string

MappingRuleMatchType_Values returns all elements of the MappingRuleMatchType enum

func RoleMappingType_Values added in v1.34.3 

func RoleMappingType_Values() []string

RoleMappingType_Values returns all elements of the RoleMappingType enum

Types

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

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *CognitoIdentity

New creates a new instance of the CognitoIdentity client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a CognitoIdentity client from just a session.
svc := cognitoidentity.New(mySession)

// Create a CognitoIdentity client with additional configuration
svc := cognitoidentity.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*CognitoIdentity) 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 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 Types:

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

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

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

  • TooManyRequestsException Thrown when a request is throttled.

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

  • 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

func (*CognitoIdentity) 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

func (*CognitoIdentity) CreateIdentityPoolWithContext added in v1.8.0 

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.

func (*CognitoIdentity) DeleteIdentities added in v0.6.1 

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 Types:

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

  • TooManyRequestsException Thrown when a request is throttled.

  • 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

func (*CognitoIdentity) DeleteIdentitiesRequest added in v0.6.1 

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

func (*CognitoIdentity) DeleteIdentitiesWithContext added in v1.8.0 

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.

func (*CognitoIdentity) DeleteIdentityPool 

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

DeleteIdentityPool API operation for Amazon Cognito Identity.

Deletes an identity 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 Types:

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

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

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

  • TooManyRequestsException Thrown when a request is throttled.

  • 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

func (*CognitoIdentity) 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

func (*CognitoIdentity) DeleteIdentityPoolWithContext added in v1.8.0 

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.

func (*CognitoIdentity) 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 Types:

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

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

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

  • TooManyRequestsException Thrown when a request is throttled.

  • 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

func (*CognitoIdentity) 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 Types:

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

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

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

  • TooManyRequestsException Thrown when a request is throttled.

  • 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

func (*CognitoIdentity) 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

func (*CognitoIdentity) DescribeIdentityPoolWithContext added in v1.8.0 

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.

func (*CognitoIdentity) 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

func (*CognitoIdentity) DescribeIdentityWithContext added in v1.8.0 

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.

func (*CognitoIdentity) 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 Types:

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

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

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

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

  • TooManyRequestsException Thrown when a request is throttled.

  • InvalidIdentityPoolConfigurationException Thrown if the identity pool has no role associated for the given auth type (auth/unauth) or if the AssumeRole fails.

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

  • 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

func (*CognitoIdentity) 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

func (*CognitoIdentity) GetCredentialsForIdentityWithContext added in v1.8.0 

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.

func (*CognitoIdentity) GetId added in v0.9.5 

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 Types:

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

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

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

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

  • TooManyRequestsException Thrown when a request is throttled.

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

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

  • 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

func (*CognitoIdentity) GetIdRequest added in v0.9.5 

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

func (*CognitoIdentity) GetIdWithContext added in v1.8.0 

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.

func (*CognitoIdentity) 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 Types:

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

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

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

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

  • TooManyRequestsException Thrown when a request is throttled.

  • 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

func (*CognitoIdentity) 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

func (*CognitoIdentity) GetIdentityPoolRolesWithContext added in v1.8.0 

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.

func (*CognitoIdentity) GetOpenIdToken added in v0.9.5 

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 10 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 Types:

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

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

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

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

  • TooManyRequestsException Thrown when a request is throttled.

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

  • 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

func (*CognitoIdentity) GetOpenIdTokenForDeveloperIdentity added in v0.9.5 

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 Types:

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

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

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

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

  • TooManyRequestsException Thrown when a request is throttled.

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

  • 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

func (*CognitoIdentity) GetOpenIdTokenForDeveloperIdentityRequest added in v0.9.5 

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

func (*CognitoIdentity) GetOpenIdTokenForDeveloperIdentityWithContext added in v1.8.0 

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.

func (*CognitoIdentity) GetOpenIdTokenRequest added in v0.9.5 

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

func (*CognitoIdentity) GetOpenIdTokenWithContext added in v1.8.0 

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.

func (*CognitoIdentity) GetPrincipalTagAttributeMap added in v1.36.27 

func (c *CognitoIdentity) GetPrincipalTagAttributeMap(input *GetPrincipalTagAttributeMapInput) (*GetPrincipalTagAttributeMapOutput, error)

GetPrincipalTagAttributeMap API operation for Amazon Cognito Identity.

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

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 GetPrincipalTagAttributeMap for usage and error information.

Returned Error Types:

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

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

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

  • TooManyRequestsException Thrown when a request is throttled.

  • 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/GetPrincipalTagAttributeMap

func (*CognitoIdentity) GetPrincipalTagAttributeMapRequest added in v1.36.27 

func (c *CognitoIdentity) GetPrincipalTagAttributeMapRequest(input *GetPrincipalTagAttributeMapInput) (req *request.Request, output *GetPrincipalTagAttributeMapOutput)

GetPrincipalTagAttributeMapRequest generates a "aws/request.Request" representing the client's request for the GetPrincipalTagAttributeMap 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 GetPrincipalTagAttributeMap for more information on using the GetPrincipalTagAttributeMap 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 GetPrincipalTagAttributeMapRequest method.
req, resp := client.GetPrincipalTagAttributeMapRequest(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/GetPrincipalTagAttributeMap

func (*CognitoIdentity) GetPrincipalTagAttributeMapWithContext added in v1.36.27 

func (c *CognitoIdentity) GetPrincipalTagAttributeMapWithContext(ctx aws.Context, input *GetPrincipalTagAttributeMapInput, opts ...request.Option) (*GetPrincipalTagAttributeMapOutput, error)

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

See GetPrincipalTagAttributeMap 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.

func (*CognitoIdentity) ListIdentities 

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

ListIdentities API operation for Amazon Cognito Identity.

Lists the identities in 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 ListIdentities for usage and error information.

Returned Error Types:

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

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

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

  • TooManyRequestsException Thrown when a request is throttled.

  • 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

func (*CognitoIdentity) 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

func (*CognitoIdentity) ListIdentitiesWithContext added in v1.8.0 

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.

func (*CognitoIdentity) 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 Types:

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

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

  • TooManyRequestsException Thrown when a request is throttled.

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

  • 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

func (*CognitoIdentity) ListIdentityPoolsPages added in v1.35.33 

func (c *CognitoIdentity) ListIdentityPoolsPages(input *ListIdentityPoolsInput, fn func(*ListIdentityPoolsOutput, bool) bool) error

ListIdentityPoolsPages iterates over the pages of a ListIdentityPools operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListIdentityPools method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListIdentityPools operation.
pageNum := 0
err := client.ListIdentityPoolsPages(params,
    func(page *cognitoidentity.ListIdentityPoolsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CognitoIdentity) ListIdentityPoolsPagesWithContext added in v1.35.33 

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

ListIdentityPoolsPagesWithContext same as ListIdentityPoolsPages except it takes a Context and allows setting request options on the pages.

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.

func (*CognitoIdentity) 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

func (*CognitoIdentity) ListIdentityPoolsWithContext added in v1.8.0 

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.

func (*CognitoIdentity) ListTagsForResource added in v1.18.6 

func (c *CognitoIdentity) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Amazon Cognito Identity.

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.

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 ListTagsForResource for usage and error information.

Returned Error Types:

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

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

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

  • TooManyRequestsException Thrown when a request is throttled.

  • 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/ListTagsForResource

func (*CognitoIdentity) ListTagsForResourceRequest added in v1.18.6 

func (c *CognitoIdentity) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource 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 ListTagsForResource for more information on using the ListTagsForResource 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 ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(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/ListTagsForResource

func (*CognitoIdentity) ListTagsForResourceWithContext added in v1.18.6 

func (c *CognitoIdentity) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

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

See ListTagsForResource 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.

func (*CognitoIdentity) 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 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 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 Types:

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

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

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

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

  • TooManyRequestsException Thrown when a request is throttled.

  • 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

func (*CognitoIdentity) 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

func (*CognitoIdentity) LookupDeveloperIdentityWithContext added in v1.8.0 

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.

func (*CognitoIdentity) 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.

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 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 Types:

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

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

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

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

  • TooManyRequestsException Thrown when a request is throttled.

  • 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

func (*CognitoIdentity) 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

func (*CognitoIdentity) MergeDeveloperIdentitiesWithContext added in v1.8.0 

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.

func (*CognitoIdentity) 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 Types:

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

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

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

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

  • TooManyRequestsException Thrown when a request is throttled.

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

  • 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

func (*CognitoIdentity) 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

func (*CognitoIdentity) SetIdentityPoolRolesWithContext added in v1.8.0 

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.

func (*CognitoIdentity) SetPrincipalTagAttributeMap added in v1.36.27 

func (c *CognitoIdentity) SetPrincipalTagAttributeMap(input *SetPrincipalTagAttributeMapInput) (*SetPrincipalTagAttributeMapOutput, error)

SetPrincipalTagAttributeMap API operation for Amazon Cognito Identity.

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

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 SetPrincipalTagAttributeMap for usage and error information.

Returned Error Types:

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

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

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

  • TooManyRequestsException Thrown when a request is throttled.

  • 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/SetPrincipalTagAttributeMap

func (*CognitoIdentity) SetPrincipalTagAttributeMapRequest added in v1.36.27 

func (c *CognitoIdentity) SetPrincipalTagAttributeMapRequest(input *SetPrincipalTagAttributeMapInput) (req *request.Request, output *SetPrincipalTagAttributeMapOutput)

SetPrincipalTagAttributeMapRequest generates a "aws/request.Request" representing the client's request for the SetPrincipalTagAttributeMap 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 SetPrincipalTagAttributeMap for more information on using the SetPrincipalTagAttributeMap 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 SetPrincipalTagAttributeMapRequest method.
req, resp := client.SetPrincipalTagAttributeMapRequest(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/SetPrincipalTagAttributeMap

func (*CognitoIdentity) SetPrincipalTagAttributeMapWithContext added in v1.36.27 

func (c *CognitoIdentity) SetPrincipalTagAttributeMapWithContext(ctx aws.Context, input *SetPrincipalTagAttributeMapInput, opts ...request.Option) (*SetPrincipalTagAttributeMapOutput, error)

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

See SetPrincipalTagAttributeMap 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.

func (*CognitoIdentity) TagResource added in v1.18.6 

func (c *CognitoIdentity) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Amazon Cognito Identity.

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.

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 TagResource for usage and error information.

Returned Error Types:

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

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

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

  • TooManyRequestsException Thrown when a request is throttled.

  • 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/TagResource

func (*CognitoIdentity) TagResourceRequest added in v1.18.6 

func (c *CognitoIdentity) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource 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 TagResource for more information on using the TagResource 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 TagResourceRequest method.
req, resp := client.TagResourceRequest(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/TagResource

func (*CognitoIdentity) TagResourceWithContext added in v1.18.6 

func (c *CognitoIdentity) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

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

See TagResource 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.

func (*CognitoIdentity) 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 Types:

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

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

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

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

  • TooManyRequestsException Thrown when a request is throttled.

  • 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

func (*CognitoIdentity) 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

func (*CognitoIdentity) UnlinkDeveloperIdentityWithContext added in v1.8.0 

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.

func (*CognitoIdentity) 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 Types:

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

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

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

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

  • TooManyRequestsException Thrown when a request is throttled.

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

  • 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

func (*CognitoIdentity) 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

func (*CognitoIdentity) UnlinkIdentityWithContext added in v1.8.0 

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.

func (*CognitoIdentity) UntagResource added in v1.18.6 

func (c *CognitoIdentity) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Amazon Cognito Identity.

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

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 UntagResource for usage and error information.

Returned Error Types:

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

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

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

  • TooManyRequestsException Thrown when a request is throttled.

  • 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/UntagResource

func (*CognitoIdentity) UntagResourceRequest added in v1.18.6 

func (c *CognitoIdentity) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource 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 UntagResource for more information on using the UntagResource 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 UntagResourceRequest method.
req, resp := client.UntagResourceRequest(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/UntagResource

func (*CognitoIdentity) UntagResourceWithContext added in v1.18.6 

func (c *CognitoIdentity) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

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

See UntagResource 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.

func (*CognitoIdentity) UpdateIdentityPool 

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

UpdateIdentityPool API operation for Amazon Cognito Identity.

Updates 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 UpdateIdentityPool for usage and error information.

Returned Error Types:

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

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

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

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

  • TooManyRequestsException Thrown when a request is throttled.

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

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

  • 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

func (*CognitoIdentity) 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

func (*CognitoIdentity) UpdateIdentityPoolWithContext added in v1.8.0 

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.

type ConcurrentModificationException added in v1.28.0 

type ConcurrentModificationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message returned by a ConcurrentModificationException.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Thrown if there are parallel requests to modify a resource.

func (*ConcurrentModificationException) Code added in v1.28.0 

func (s *ConcurrentModificationException) Code() string

Code returns the exception type name.

func (*ConcurrentModificationException) Error added in v1.28.0 

func (s *ConcurrentModificationException) Error() string

func (ConcurrentModificationException) GoString added in v1.28.0 

func (s ConcurrentModificationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConcurrentModificationException) Message added in v1.28.0 

func (s *ConcurrentModificationException) Message() string

Message returns the exception's message.

func (*ConcurrentModificationException) OrigErr added in v1.28.0 

func (s *ConcurrentModificationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConcurrentModificationException) RequestID added in v1.28.0 

func (s *ConcurrentModificationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConcurrentModificationException) StatusCode added in v1.28.0 

func (s *ConcurrentModificationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConcurrentModificationException) String added in v1.28.0 

func (s ConcurrentModificationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateIdentityPoolInput 

type CreateIdentityPoolInput struct {

	// Enables or disables the Basic (Classic) authentication flow. For more information,
	// see Identity Pools (Federated Identities) Authentication Flow (https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html)
	// in the Amazon Cognito Developer Guide.
	AllowClassicFlow *bool `type:"boolean"`

	// TRUE if the identity pool supports unauthenticated logins.
	//
	// AllowUnauthenticatedIdentities is a required field
	AllowUnauthenticatedIdentities *bool `type:"boolean" required:"true"`

	// An array of Amazon Cognito user pools and their client IDs.
	CognitoIdentityProviders []*Provider `type:"list"`

	// 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.
	DeveloperProviderName *string `min:"1" type:"string"`

	// A string that you provide.
	//
	// IdentityPoolName is a required field
	IdentityPoolName *string `min:"1" type:"string" required:"true"`

	// 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.
	IdentityPoolTags map[string]*string `type:"map"`

	// The Amazon Resource Names (ARN) of the OpenID Connect providers.
	OpenIdConnectProviderARNs []*string `type:"list"`

	// An array of Amazon Resource Names (ARNs) of the SAML provider for your identity
	// pool.
	SamlProviderARNs []*string `type:"list"`

	// Optional key:value pairs mapping provider names to provider app IDs.
	SupportedLoginProviders map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

Input to the CreateIdentityPool action.

func (CreateIdentityPoolInput) GoString added in v0.6.5 

func (s CreateIdentityPoolInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateIdentityPoolInput) SetAllowClassicFlow added in v1.25.31 

func (s *CreateIdentityPoolInput) SetAllowClassicFlow(v bool) *CreateIdentityPoolInput

SetAllowClassicFlow sets the AllowClassicFlow field's value.

func (*CreateIdentityPoolInput) SetAllowUnauthenticatedIdentities added in v1.5.0 

func (s *CreateIdentityPoolInput) SetAllowUnauthenticatedIdentities(v bool) *CreateIdentityPoolInput

SetAllowUnauthenticatedIdentities sets the AllowUnauthenticatedIdentities field's value.

func (*CreateIdentityPoolInput) SetCognitoIdentityProviders added in v1.5.0 

func (s *CreateIdentityPoolInput) SetCognitoIdentityProviders(v []*Provider) *CreateIdentityPoolInput

SetCognitoIdentityProviders sets the CognitoIdentityProviders field's value.

func (*CreateIdentityPoolInput) SetDeveloperProviderName added in v1.5.0 

func (s *CreateIdentityPoolInput) SetDeveloperProviderName(v string) *CreateIdentityPoolInput

SetDeveloperProviderName sets the DeveloperProviderName field's value.

func (*CreateIdentityPoolInput) SetIdentityPoolName added in v1.5.0 

func (s *CreateIdentityPoolInput) SetIdentityPoolName(v string) *CreateIdentityPoolInput

SetIdentityPoolName sets the IdentityPoolName field's value.

func (*CreateIdentityPoolInput) SetIdentityPoolTags added in v1.18.6 

func (s *CreateIdentityPoolInput) SetIdentityPoolTags(v map[string]*string) *CreateIdentityPoolInput

SetIdentityPoolTags sets the IdentityPoolTags field's value.

func (*CreateIdentityPoolInput) SetOpenIdConnectProviderARNs added in v1.5.0 

func (s *CreateIdentityPoolInput) SetOpenIdConnectProviderARNs(v []*string) *CreateIdentityPoolInput

SetOpenIdConnectProviderARNs sets the OpenIdConnectProviderARNs field's value.

func (*CreateIdentityPoolInput) SetSamlProviderARNs added in v1.5.0 

func (s *CreateIdentityPoolInput) SetSamlProviderARNs(v []*string) *CreateIdentityPoolInput

SetSamlProviderARNs sets the SamlProviderARNs field's value.

func (*CreateIdentityPoolInput) SetSupportedLoginProviders added in v1.5.0 

func (s *CreateIdentityPoolInput) SetSupportedLoginProviders(v map[string]*string) *CreateIdentityPoolInput

SetSupportedLoginProviders sets the SupportedLoginProviders field's value.

func (CreateIdentityPoolInput) String added in v0.6.5 

func (s CreateIdentityPoolInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateIdentityPoolInput) Validate added in v1.1.21 

func (s *CreateIdentityPoolInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Credentials 

type Credentials struct {

	// The Access Key portion of the credentials.
	AccessKeyId *string `type:"string"`

	// The date at which these credentials will expire.
	Expiration *time.Time `type:"timestamp"`

	// The Secret Access Key portion of the credentials
	SecretKey *string `type:"string"`

	// The Session Token portion of the credentials
	SessionToken *string `type:"string"`
	// contains filtered or unexported fields
}

Credentials for the provided identity ID.

func (Credentials) GoString added in v0.6.5 

func (s Credentials) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Credentials) SetAccessKeyId added in v1.5.0 

func (s *Credentials) SetAccessKeyId(v string) *Credentials

SetAccessKeyId sets the AccessKeyId field's value.

func (*Credentials) SetExpiration added in v1.5.0 

func (s *Credentials) SetExpiration(v time.Time) *Credentials

SetExpiration sets the Expiration field's value.

func (*Credentials) SetSecretKey added in v1.5.0 

func (s *Credentials) SetSecretKey(v string) *Credentials

SetSecretKey sets the SecretKey field's value.

func (*Credentials) SetSessionToken added in v1.5.0 

func (s *Credentials) SetSessionToken(v string) *Credentials

SetSessionToken sets the SessionToken field's value.

func (Credentials) String added in v0.6.5 

func (s Credentials) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteIdentitiesInput added in v0.6.1 

type DeleteIdentitiesInput struct {

	// A list of 1-60 identities that you want to delete.
	//
	// IdentityIdsToDelete is a required field
	IdentityIdsToDelete []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Input to the DeleteIdentities action.

func (DeleteIdentitiesInput) GoString added in v0.6.5 

func (s DeleteIdentitiesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteIdentitiesInput) SetIdentityIdsToDelete added in v1.5.0 

func (s *DeleteIdentitiesInput) SetIdentityIdsToDelete(v []*string) *DeleteIdentitiesInput

SetIdentityIdsToDelete sets the IdentityIdsToDelete field's value.

func (DeleteIdentitiesInput) String added in v0.6.5 

func (s DeleteIdentitiesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteIdentitiesInput) Validate added in v1.1.21 

func (s *DeleteIdentitiesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteIdentitiesOutput added in v0.6.1 

type DeleteIdentitiesOutput struct {

	// An array of UnprocessedIdentityId objects, each of which contains an ErrorCode
	// and IdentityId.
	UnprocessedIdentityIds []*UnprocessedIdentityId `type:"list"`
	// contains filtered or unexported fields
}

Returned in response to a successful DeleteIdentities operation.

func (DeleteIdentitiesOutput) GoString added in v0.6.5 

func (s DeleteIdentitiesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteIdentitiesOutput) SetUnprocessedIdentityIds added in v1.5.0 

func (s *DeleteIdentitiesOutput) SetUnprocessedIdentityIds(v []*UnprocessedIdentityId) *DeleteIdentitiesOutput

SetUnprocessedIdentityIds sets the UnprocessedIdentityIds field's value.

func (DeleteIdentitiesOutput) String added in v0.6.5 

func (s DeleteIdentitiesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteIdentityPoolInput 

type DeleteIdentityPoolInput struct {

	// An identity pool ID in the format REGION:GUID.
	//
	// IdentityPoolId is a required field
	IdentityPoolId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input to the DeleteIdentityPool action.

func (DeleteIdentityPoolInput) GoString added in v0.6.5 

func (s DeleteIdentityPoolInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteIdentityPoolInput) SetIdentityPoolId added in v1.5.0 

func (s *DeleteIdentityPoolInput) SetIdentityPoolId(v string) *DeleteIdentityPoolInput

SetIdentityPoolId sets the IdentityPoolId field's value.

func (DeleteIdentityPoolInput) String added in v0.6.5 

func (s DeleteIdentityPoolInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteIdentityPoolInput) Validate added in v1.1.21 

func (s *DeleteIdentityPoolInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteIdentityPoolOutput 

type DeleteIdentityPoolOutput struct {
	// contains filtered or unexported fields
}

func (DeleteIdentityPoolOutput) GoString added in v0.6.5 

func (s DeleteIdentityPoolOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteIdentityPoolOutput) String added in v0.6.5 

func (s DeleteIdentityPoolOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeIdentityInput 

type DescribeIdentityInput struct {

	// A unique identifier in the format REGION:GUID.
	//
	// IdentityId is a required field
	IdentityId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input to the DescribeIdentity action.

func (DescribeIdentityInput) GoString added in v0.6.5 

func (s DescribeIdentityInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeIdentityInput) SetIdentityId added in v1.5.0 

func (s *DescribeIdentityInput) SetIdentityId(v string) *DescribeIdentityInput

SetIdentityId sets the IdentityId field's value.

func (DescribeIdentityInput) String added in v0.6.5 

func (s DescribeIdentityInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeIdentityInput) Validate added in v1.1.21 

func (s *DescribeIdentityInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeIdentityPoolInput 

type DescribeIdentityPoolInput struct {

	// An identity pool ID in the format REGION:GUID.
	//
	// IdentityPoolId is a required field
	IdentityPoolId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input to the DescribeIdentityPool action.

func (DescribeIdentityPoolInput) GoString added in v0.6.5 

func (s DescribeIdentityPoolInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeIdentityPoolInput) SetIdentityPoolId added in v1.5.0 

func (s *DescribeIdentityPoolInput) SetIdentityPoolId(v string) *DescribeIdentityPoolInput

SetIdentityPoolId sets the IdentityPoolId field's value.

func (DescribeIdentityPoolInput) String added in v0.6.5 

func (s DescribeIdentityPoolInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeIdentityPoolInput) Validate added in v1.1.21 

func (s *DescribeIdentityPoolInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeveloperUserAlreadyRegisteredException added in v1.28.0 

type DeveloperUserAlreadyRegisteredException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// This developer user identifier is already registered with Cognito.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*DeveloperUserAlreadyRegisteredException) Code added in v1.28.0 

func (s *DeveloperUserAlreadyRegisteredException) Code() string

Code returns the exception type name.

func (*DeveloperUserAlreadyRegisteredException) Error added in v1.28.0 

func (s *DeveloperUserAlreadyRegisteredException) Error() string

func (DeveloperUserAlreadyRegisteredException) GoString added in v1.28.0 

func (s DeveloperUserAlreadyRegisteredException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeveloperUserAlreadyRegisteredException) Message added in v1.28.0 

func (s *DeveloperUserAlreadyRegisteredException) Message() string

Message returns the exception's message.

func (*DeveloperUserAlreadyRegisteredException) OrigErr added in v1.28.0 

func (s *DeveloperUserAlreadyRegisteredException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*DeveloperUserAlreadyRegisteredException) RequestID added in v1.28.0 

func (s *DeveloperUserAlreadyRegisteredException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*DeveloperUserAlreadyRegisteredException) StatusCode added in v1.28.0 

func (s *DeveloperUserAlreadyRegisteredException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (DeveloperUserAlreadyRegisteredException) String added in v1.28.0 

func (s DeveloperUserAlreadyRegisteredException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExternalServiceException added in v1.28.0 

type ExternalServiceException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message returned by an ExternalServiceException
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

An exception thrown when a dependent service such as Facebook or Twitter is not responding

func (*ExternalServiceException) Code added in v1.28.0 

func (s *ExternalServiceException) Code() string

Code returns the exception type name.

func (*ExternalServiceException) Error added in v1.28.0 

func (s *ExternalServiceException) Error() string

func (ExternalServiceException) GoString added in v1.28.0 

func (s ExternalServiceException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExternalServiceException) Message added in v1.28.0 

func (s *ExternalServiceException) Message() string

Message returns the exception's message.

func (*ExternalServiceException) OrigErr added in v1.28.0 

func (s *ExternalServiceException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ExternalServiceException) RequestID added in v1.28.0 

func (s *ExternalServiceException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ExternalServiceException) StatusCode added in v1.28.0 

func (s *ExternalServiceException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ExternalServiceException) String added in v1.28.0 

func (s ExternalServiceException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetCredentialsForIdentityInput 

type GetCredentialsForIdentityInput struct {

	// 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.
	CustomRoleArn *string `min:"20" type:"string"`

	// A unique identifier in the format REGION:GUID.
	//
	// IdentityId is a required field
	IdentityId *string `min:"1" type:"string" required:"true"`

	// 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 (https://docs.aws.amazon.com/cognito/latest/developerguide/external-identity-providers.html)
	// section of the Amazon Cognito Developer Guide.
	Logins map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

Input to the GetCredentialsForIdentity action.

func (GetCredentialsForIdentityInput) GoString added in v0.6.5 

func (s GetCredentialsForIdentityInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCredentialsForIdentityInput) SetCustomRoleArn added in v1.5.0 

func (s *GetCredentialsForIdentityInput) SetCustomRoleArn(v string) *GetCredentialsForIdentityInput

SetCustomRoleArn sets the CustomRoleArn field's value.

func (*GetCredentialsForIdentityInput) SetIdentityId added in v1.5.0 

func (s *GetCredentialsForIdentityInput) SetIdentityId(v string) *GetCredentialsForIdentityInput

SetIdentityId sets the IdentityId field's value.

func (*GetCredentialsForIdentityInput) SetLogins added in v1.5.0 

func (s *GetCredentialsForIdentityInput) SetLogins(v map[string]*string) *GetCredentialsForIdentityInput

SetLogins sets the Logins field's value.

func (GetCredentialsForIdentityInput) String added in v0.6.5 

func (s GetCredentialsForIdentityInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCredentialsForIdentityInput) Validate added in v1.1.21 

func (s *GetCredentialsForIdentityInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetCredentialsForIdentityOutput 

type GetCredentialsForIdentityOutput struct {

	// Credentials for the provided identity ID.
	Credentials *Credentials `type:"structure"`

	// A unique identifier in the format REGION:GUID.
	IdentityId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Returned in response to a successful GetCredentialsForIdentity operation.

func (GetCredentialsForIdentityOutput) GoString added in v0.6.5 

func (s GetCredentialsForIdentityOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCredentialsForIdentityOutput) SetCredentials added in v1.5.0 

func (s *GetCredentialsForIdentityOutput) SetCredentials(v *Credentials) *GetCredentialsForIdentityOutput

SetCredentials sets the Credentials field's value.

func (*GetCredentialsForIdentityOutput) SetIdentityId added in v1.5.0 

func (s *GetCredentialsForIdentityOutput) SetIdentityId(v string) *GetCredentialsForIdentityOutput

SetIdentityId sets the IdentityId field's value.

func (GetCredentialsForIdentityOutput) String added in v0.6.5 

func (s GetCredentialsForIdentityOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetIdInput added in v0.9.5 

type GetIdInput struct {

	// A standard AWS account ID (9+ digits).
	AccountId *string `min:"1" type:"string"`

	// An identity pool ID in the format REGION:GUID.
	//
	// IdentityPoolId is a required field
	IdentityPoolId *string `min:"1" type:"string" required:"true"`

	// 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
	Logins map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

Input to the GetId action.

func (GetIdInput) GoString added in v0.9.5 

func (s GetIdInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetIdInput) SetAccountId added in v1.5.0 

func (s *GetIdInput) SetAccountId(v string) *GetIdInput

SetAccountId sets the AccountId field's value.

func (*GetIdInput) SetIdentityPoolId added in v1.5.0 

func (s *GetIdInput) SetIdentityPoolId(v string) *GetIdInput

SetIdentityPoolId sets the IdentityPoolId field's value.

func (*GetIdInput) SetLogins added in v1.5.0 

func (s *GetIdInput) SetLogins(v map[string]*string) *GetIdInput

SetLogins sets the Logins field's value.

func (GetIdInput) String added in v0.9.5 

func (s GetIdInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetIdInput) Validate added in v1.1.21 

func (s *GetIdInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetIdOutput added in v0.9.5 

type GetIdOutput struct {

	// A unique identifier in the format REGION:GUID.
	IdentityId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Returned in response to a GetId request.

func (GetIdOutput) GoString added in v0.9.5 

func (s GetIdOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetIdOutput) SetIdentityId added in v1.5.0 

func (s *GetIdOutput) SetIdentityId(v string) *GetIdOutput

SetIdentityId sets the IdentityId field's value.

func (GetIdOutput) String added in v0.9.5 

func (s GetIdOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetIdentityPoolRolesInput 

type GetIdentityPoolRolesInput struct {

	// An identity pool ID in the format REGION:GUID.
	//
	// IdentityPoolId is a required field
	IdentityPoolId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input to the GetIdentityPoolRoles action.

func (GetIdentityPoolRolesInput) GoString added in v0.6.5 

func (s GetIdentityPoolRolesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetIdentityPoolRolesInput) SetIdentityPoolId added in v1.5.0 

func (s *GetIdentityPoolRolesInput) SetIdentityPoolId(v string) *GetIdentityPoolRolesInput

SetIdentityPoolId sets the IdentityPoolId field's value.

func (GetIdentityPoolRolesInput) String added in v0.6.5 

func (s GetIdentityPoolRolesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetIdentityPoolRolesInput) Validate added in v1.1.21 

func (s *GetIdentityPoolRolesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetIdentityPoolRolesOutput 

type GetIdentityPoolRolesOutput struct {

	// An identity pool ID in the format REGION:GUID.
	IdentityPoolId *string `min:"1" type:"string"`

	// 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".
	RoleMappings map[string]*RoleMapping `type:"map"`

	// The map of roles associated with this pool. Currently only authenticated
	// and unauthenticated roles are supported.
	Roles map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

Returned in response to a successful GetIdentityPoolRoles operation.

func (GetIdentityPoolRolesOutput) GoString added in v0.6.5 

func (s GetIdentityPoolRolesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetIdentityPoolRolesOutput) SetIdentityPoolId added in v1.5.0 

func (s *GetIdentityPoolRolesOutput) SetIdentityPoolId(v string) *GetIdentityPoolRolesOutput

SetIdentityPoolId sets the IdentityPoolId field's value.

func (*GetIdentityPoolRolesOutput) SetRoleMappings added in v1.6.5 

func (s *GetIdentityPoolRolesOutput) SetRoleMappings(v map[string]*RoleMapping) *GetIdentityPoolRolesOutput

SetRoleMappings sets the RoleMappings field's value.

func (*GetIdentityPoolRolesOutput) SetRoles added in v1.5.0 

func (s *GetIdentityPoolRolesOutput) SetRoles(v map[string]*string) *GetIdentityPoolRolesOutput

SetRoles sets the Roles field's value.

func (GetIdentityPoolRolesOutput) String added in v0.6.5 

func (s GetIdentityPoolRolesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetOpenIdTokenForDeveloperIdentityInput added in v0.9.5 

type GetOpenIdTokenForDeveloperIdentityInput struct {

	// A unique identifier in the format REGION:GUID.
	IdentityId *string `min:"1" type:"string"`

	// An identity pool ID in the format REGION:GUID.
	//
	// IdentityPoolId is a required field
	IdentityPoolId *string `min:"1" type:"string" required:"true"`

	// 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.
	//
	// Logins is a required field
	Logins map[string]*string `type:"map" required:"true"`

	// Use this operation to configure attribute mappings for custom providers.
	PrincipalTags map[string]*string `type:"map"`

	// 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 AWS 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
	// AWS resources for the token's duration.
	//
	// Please provide for a small grace period, usually no more than 5 minutes,
	// to account for clock skew.
	TokenDuration *int64 `min:"1" type:"long"`
	// contains filtered or unexported fields
}

Input to the GetOpenIdTokenForDeveloperIdentity action.

func (GetOpenIdTokenForDeveloperIdentityInput) GoString added in v0.9.5 

func (s GetOpenIdTokenForDeveloperIdentityInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetOpenIdTokenForDeveloperIdentityInput) SetIdentityId added in v1.5.0 

func (s *GetOpenIdTokenForDeveloperIdentityInput) SetIdentityId(v string) *GetOpenIdTokenForDeveloperIdentityInput

SetIdentityId sets the IdentityId field's value.

func (*GetOpenIdTokenForDeveloperIdentityInput) SetIdentityPoolId added in v1.5.0 

func (s *GetOpenIdTokenForDeveloperIdentityInput) SetIdentityPoolId(v string) *GetOpenIdTokenForDeveloperIdentityInput

SetIdentityPoolId sets the IdentityPoolId field's value.

func (*GetOpenIdTokenForDeveloperIdentityInput) SetLogins added in v1.5.0 

func (s *GetOpenIdTokenForDeveloperIdentityInput) SetLogins(v map[string]*string) *GetOpenIdTokenForDeveloperIdentityInput

SetLogins sets the Logins field's value.

func (*GetOpenIdTokenForDeveloperIdentityInput) SetPrincipalTags added in v1.36.27 

func (s *GetOpenIdTokenForDeveloperIdentityInput) SetPrincipalTags(v map[string]*string) *GetOpenIdTokenForDeveloperIdentityInput

SetPrincipalTags sets the PrincipalTags field's value.

func (*GetOpenIdTokenForDeveloperIdentityInput) SetTokenDuration added in v1.5.0 

func (s *GetOpenIdTokenForDeveloperIdentityInput) SetTokenDuration(v int64) *GetOpenIdTokenForDeveloperIdentityInput

SetTokenDuration sets the TokenDuration field's value.

func (GetOpenIdTokenForDeveloperIdentityInput) String added in v0.9.5 

func (s GetOpenIdTokenForDeveloperIdentityInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetOpenIdTokenForDeveloperIdentityInput) Validate added in v1.1.21 

func (s *GetOpenIdTokenForDeveloperIdentityInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetOpenIdTokenForDeveloperIdentityOutput added in v0.9.5 

type GetOpenIdTokenForDeveloperIdentityOutput struct {

	// A unique identifier in the format REGION:GUID.
	IdentityId *string `min:"1" type:"string"`

	// An OpenID token.
	Token *string `type:"string"`
	// contains filtered or unexported fields
}

Returned in response to a successful GetOpenIdTokenForDeveloperIdentity request.

func (GetOpenIdTokenForDeveloperIdentityOutput) GoString added in v0.9.5 

func (s GetOpenIdTokenForDeveloperIdentityOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetOpenIdTokenForDeveloperIdentityOutput) SetIdentityId added in v1.5.0 

func (s *GetOpenIdTokenForDeveloperIdentityOutput) SetIdentityId(v string) *GetOpenIdTokenForDeveloperIdentityOutput

SetIdentityId sets the IdentityId field's value.

func (*GetOpenIdTokenForDeveloperIdentityOutput) SetToken added in v1.5.0 

func (s *GetOpenIdTokenForDeveloperIdentityOutput) SetToken(v string) *GetOpenIdTokenForDeveloperIdentityOutput

SetToken sets the Token field's value.

func (GetOpenIdTokenForDeveloperIdentityOutput) String added in v0.9.5 

func (s GetOpenIdTokenForDeveloperIdentityOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetOpenIdTokenInput added in v0.9.5 

type GetOpenIdTokenInput struct {

	// A unique identifier in the format REGION:GUID.
	//
	// IdentityId is a required field
	IdentityId *string `min:"1" type:"string" required:"true"`

	// 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.
	Logins map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

Input to the GetOpenIdToken action.

func (GetOpenIdTokenInput) GoString added in v0.9.5 

func (s GetOpenIdTokenInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetOpenIdTokenInput) SetIdentityId added in v1.5.0 

func (s *GetOpenIdTokenInput) SetIdentityId(v string) *GetOpenIdTokenInput

SetIdentityId sets the IdentityId field's value.

func (*GetOpenIdTokenInput) SetLogins added in v1.5.0 

func (s *GetOpenIdTokenInput) SetLogins(v map[string]*string) *GetOpenIdTokenInput

SetLogins sets the Logins field's value.

func (GetOpenIdTokenInput) String added in v0.9.5 

func (s GetOpenIdTokenInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetOpenIdTokenInput) Validate added in v1.1.21 

func (s *GetOpenIdTokenInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetOpenIdTokenOutput added in v0.9.5 

type GetOpenIdTokenOutput struct {

	// A unique identifier in the format REGION:GUID. Note that the IdentityId returned
	// may not match the one passed on input.
	IdentityId *string `min:"1" type:"string"`

	// An OpenID token, valid for 10 minutes.
	Token *string `type:"string"`
	// contains filtered or unexported fields
}

Returned in response to a successful GetOpenIdToken request.

func (GetOpenIdTokenOutput) GoString added in v0.9.5 

func (s GetOpenIdTokenOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetOpenIdTokenOutput) SetIdentityId added in v1.5.0 

func (s *GetOpenIdTokenOutput) SetIdentityId(v string) *GetOpenIdTokenOutput

SetIdentityId sets the IdentityId field's value.

func (*GetOpenIdTokenOutput) SetToken added in v1.5.0 

func (s *GetOpenIdTokenOutput) SetToken(v string) *GetOpenIdTokenOutput

SetToken sets the Token field's value.

func (GetOpenIdTokenOutput) String added in v0.9.5 

func (s GetOpenIdTokenOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetPrincipalTagAttributeMapInput added in v1.36.27 

type GetPrincipalTagAttributeMapInput struct {

	// You can use this operation to get the ID of the Identity Pool you setup attribute
	// mappings for.
	//
	// IdentityPoolId is a required field
	IdentityPoolId *string `min:"1" type:"string" required:"true"`

	// You can use this operation to get the provider name.
	//
	// IdentityProviderName is a required field
	IdentityProviderName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetPrincipalTagAttributeMapInput) GoString added in v1.36.27 

func (s GetPrincipalTagAttributeMapInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetPrincipalTagAttributeMapInput) SetIdentityPoolId added in v1.36.27 

func (s *GetPrincipalTagAttributeMapInput) SetIdentityPoolId(v string) *GetPrincipalTagAttributeMapInput

SetIdentityPoolId sets the IdentityPoolId field's value.

func (*GetPrincipalTagAttributeMapInput) SetIdentityProviderName added in v1.36.27 

func (s *GetPrincipalTagAttributeMapInput) SetIdentityProviderName(v string) *GetPrincipalTagAttributeMapInput

SetIdentityProviderName sets the IdentityProviderName field's value.

func (GetPrincipalTagAttributeMapInput) String added in v1.36.27 

func (s GetPrincipalTagAttributeMapInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetPrincipalTagAttributeMapInput) Validate added in v1.36.27 

func (s *GetPrincipalTagAttributeMapInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetPrincipalTagAttributeMapOutput added in v1.36.27 

type GetPrincipalTagAttributeMapOutput struct {

	// You can use this operation to get the ID of the Identity Pool you setup attribute
	// mappings for.
	IdentityPoolId *string `min:"1" type:"string"`

	// You can use this operation to get the provider name.
	IdentityProviderName *string `min:"1" type:"string"`

	// You can use this operation to add principal tags. The PrincipalTagsoperation
	// enables you to reference user attributes in your IAM permissions policy.
	PrincipalTags map[string]*string `type:"map"`

	// You can use this operation to list
	UseDefaults *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (GetPrincipalTagAttributeMapOutput) GoString added in v1.36.27 

func (s GetPrincipalTagAttributeMapOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetPrincipalTagAttributeMapOutput) SetIdentityPoolId added in v1.36.27 

func (s *GetPrincipalTagAttributeMapOutput) SetIdentityPoolId(v string) *GetPrincipalTagAttributeMapOutput

SetIdentityPoolId sets the IdentityPoolId field's value.

func (*GetPrincipalTagAttributeMapOutput) SetIdentityProviderName added in v1.36.27 

func (s *GetPrincipalTagAttributeMapOutput) SetIdentityProviderName(v string) *GetPrincipalTagAttributeMapOutput

SetIdentityProviderName sets the IdentityProviderName field's value.

func (*GetPrincipalTagAttributeMapOutput) SetPrincipalTags added in v1.36.27 

func (s *GetPrincipalTagAttributeMapOutput) SetPrincipalTags(v map[string]*string) *GetPrincipalTagAttributeMapOutput

SetPrincipalTags sets the PrincipalTags field's value.

func (*GetPrincipalTagAttributeMapOutput) SetUseDefaults added in v1.36.27 

func (s *GetPrincipalTagAttributeMapOutput) SetUseDefaults(v bool) *GetPrincipalTagAttributeMapOutput

SetUseDefaults sets the UseDefaults field's value.

func (GetPrincipalTagAttributeMapOutput) String added in v1.36.27 

func (s GetPrincipalTagAttributeMapOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IdentityDescription 

type IdentityDescription struct {

	// Date on which the identity was created.
	CreationDate *time.Time `type:"timestamp"`

	// A unique identifier in the format REGION:GUID.
	IdentityId *string `min:"1" type:"string"`

	// Date on which the identity was last modified.
	LastModifiedDate *time.Time `type:"timestamp"`

	// The provider names.
	Logins []*string `type:"list"`
	// contains filtered or unexported fields
}

A description of the identity.

func (IdentityDescription) GoString added in v0.6.5 

func (s IdentityDescription) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IdentityDescription) SetCreationDate added in v1.5.0 

func (s *IdentityDescription) SetCreationDate(v time.Time) *IdentityDescription

SetCreationDate sets the CreationDate field's value.

func (*IdentityDescription) SetIdentityId added in v1.5.0 

func (s *IdentityDescription) SetIdentityId(v string) *IdentityDescription

SetIdentityId sets the IdentityId field's value.

func (*IdentityDescription) SetLastModifiedDate added in v1.5.0 

func (s *IdentityDescription) SetLastModifiedDate(v time.Time) *IdentityDescription

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*IdentityDescription) SetLogins added in v1.5.0 

func (s *IdentityDescription) SetLogins(v []*string) *IdentityDescription

SetLogins sets the Logins field's value.

func (IdentityDescription) String added in v0.6.5 

func (s IdentityDescription) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IdentityPool 

type IdentityPool struct {

	// Enables or disables the Basic (Classic) authentication flow. For more information,
	// see Identity Pools (Federated Identities) Authentication Flow (https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html)
	// in the Amazon Cognito Developer Guide.
	AllowClassicFlow *bool `type:"boolean"`

	// TRUE if the identity pool supports unauthenticated logins.
	//
	// AllowUnauthenticatedIdentities is a required field
	AllowUnauthenticatedIdentities *bool `type:"boolean" required:"true"`

	// A list representing an Amazon Cognito user pool and its client ID.
	CognitoIdentityProviders []*Provider `type:"list"`

	// The "domain" by which Cognito will refer to your users.
	DeveloperProviderName *string `min:"1" type:"string"`

	// An identity pool ID in the format REGION:GUID.
	//
	// IdentityPoolId is a required field
	IdentityPoolId *string `min:"1" type:"string" required:"true"`

	// A string that you provide.
	//
	// IdentityPoolName is a required field
	IdentityPoolName *string `min:"1" type:"string" required:"true"`

	// 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.
	IdentityPoolTags map[string]*string `type:"map"`

	// The ARNs of the OpenID Connect providers.
	OpenIdConnectProviderARNs []*string `type:"list"`

	// An array of Amazon Resource Names (ARNs) of the SAML provider for your identity
	// pool.
	SamlProviderARNs []*string `type:"list"`

	// Optional key:value pairs mapping provider names to provider app IDs.
	SupportedLoginProviders map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

An object representing an Amazon Cognito identity pool.

func (IdentityPool) GoString added in v0.6.5 

func (s IdentityPool) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IdentityPool) SetAllowClassicFlow added in v1.25.31 

func (s *IdentityPool) SetAllowClassicFlow(v bool) *IdentityPool

SetAllowClassicFlow sets the AllowClassicFlow field's value.

func (*IdentityPool) SetAllowUnauthenticatedIdentities added in v1.5.0 

func (s *IdentityPool) SetAllowUnauthenticatedIdentities(v bool) *IdentityPool

SetAllowUnauthenticatedIdentities sets the AllowUnauthenticatedIdentities field's value.

func (*IdentityPool) SetCognitoIdentityProviders added in v1.5.0 

func (s *IdentityPool) SetCognitoIdentityProviders(v []*Provider) *IdentityPool

SetCognitoIdentityProviders sets the CognitoIdentityProviders field's value.

func (*IdentityPool) SetDeveloperProviderName added in v1.5.0 

func (s *IdentityPool) SetDeveloperProviderName(v string) *IdentityPool

SetDeveloperProviderName sets the DeveloperProviderName field's value.

func (*IdentityPool) SetIdentityPoolId added in v1.5.0 

func (s *IdentityPool) SetIdentityPoolId(v string) *IdentityPool

SetIdentityPoolId sets the IdentityPoolId field's value.

func (*IdentityPool) SetIdentityPoolName added in v1.5.0 

func (s *IdentityPool) SetIdentityPoolName(v string) *IdentityPool

SetIdentityPoolName sets the IdentityPoolName field's value.

func (*IdentityPool) SetIdentityPoolTags added in v1.18.6 

func (s *IdentityPool) SetIdentityPoolTags(v map[string]*string) *IdentityPool

SetIdentityPoolTags sets the IdentityPoolTags field's value.

func (*IdentityPool) SetOpenIdConnectProviderARNs added in v1.5.0 

func (s *IdentityPool) SetOpenIdConnectProviderARNs(v []*string) *IdentityPool

SetOpenIdConnectProviderARNs sets the OpenIdConnectProviderARNs field's value.

func (*IdentityPool) SetSamlProviderARNs added in v1.5.0 

func (s *IdentityPool) SetSamlProviderARNs(v []*string) *IdentityPool

SetSamlProviderARNs sets the SamlProviderARNs field's value.

func (*IdentityPool) SetSupportedLoginProviders added in v1.5.0 

func (s *IdentityPool) SetSupportedLoginProviders(v map[string]*string) *IdentityPool

SetSupportedLoginProviders sets the SupportedLoginProviders field's value.

func (IdentityPool) String added in v0.6.5 

func (s IdentityPool) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IdentityPool) Validate added in v1.1.21 

func (s *IdentityPool) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type IdentityPoolShortDescription 

type IdentityPoolShortDescription struct {

	// An identity pool ID in the format REGION:GUID.
	IdentityPoolId *string `min:"1" type:"string"`

	// A string that you provide.
	IdentityPoolName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

A description of the identity pool.

func (IdentityPoolShortDescription) GoString added in v0.6.5 

func (s IdentityPoolShortDescription) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IdentityPoolShortDescription) SetIdentityPoolId added in v1.5.0 

func (s *IdentityPoolShortDescription) SetIdentityPoolId(v string) *IdentityPoolShortDescription

SetIdentityPoolId sets the IdentityPoolId field's value.

func (*IdentityPoolShortDescription) SetIdentityPoolName added in v1.5.0 

func (s *IdentityPoolShortDescription) SetIdentityPoolName(v string) *IdentityPoolShortDescription

SetIdentityPoolName sets the IdentityPoolName field's value.

func (IdentityPoolShortDescription) String added in v0.6.5 

func (s IdentityPoolShortDescription) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalErrorException added in v1.28.0 

type InternalErrorException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message returned by an InternalErrorException.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Thrown when the service encounters an error during processing the request.

func (*InternalErrorException) Code added in v1.28.0 

func (s *InternalErrorException) Code() string

Code returns the exception type name.

func (*InternalErrorException) Error added in v1.28.0 

func (s *InternalErrorException) Error() string

func (InternalErrorException) GoString added in v1.28.0 

func (s InternalErrorException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalErrorException) Message added in v1.28.0 

func (s *InternalErrorException) Message() string

Message returns the exception's message.

func (*InternalErrorException) OrigErr added in v1.28.0 

func (s *InternalErrorException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalErrorException) RequestID added in v1.28.0 

func (s *InternalErrorException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalErrorException) StatusCode added in v1.28.0 

func (s *InternalErrorException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalErrorException) String added in v1.28.0 

func (s InternalErrorException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidIdentityPoolConfigurationException added in v1.28.0 

type InvalidIdentityPoolConfigurationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message returned for an InvalidIdentityPoolConfigurationException
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Thrown if the identity pool has no role associated for the given auth type (auth/unauth) or if the AssumeRole fails.

func (*InvalidIdentityPoolConfigurationException) Code added in v1.28.0 

func (s *InvalidIdentityPoolConfigurationException) Code() string

Code returns the exception type name.

func (*InvalidIdentityPoolConfigurationException) Error added in v1.28.0 

func (s *InvalidIdentityPoolConfigurationException) Error() string

func (InvalidIdentityPoolConfigurationException) GoString added in v1.28.0 

func (s InvalidIdentityPoolConfigurationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidIdentityPoolConfigurationException) Message added in v1.28.0 

func (s *InvalidIdentityPoolConfigurationException) Message() string

Message returns the exception's message.

func (*InvalidIdentityPoolConfigurationException) OrigErr added in v1.28.0 

func (s *InvalidIdentityPoolConfigurationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidIdentityPoolConfigurationException) RequestID added in v1.28.0 

func (s *InvalidIdentityPoolConfigurationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidIdentityPoolConfigurationException) StatusCode added in v1.28.0 

func (s *InvalidIdentityPoolConfigurationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidIdentityPoolConfigurationException) String added in v1.28.0 

func (s InvalidIdentityPoolConfigurationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidParameterException added in v1.28.0 

type InvalidParameterException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message returned by an InvalidParameterException.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Thrown for missing or bad input parameter(s).

func (*InvalidParameterException) Code added in v1.28.0 

func (s *InvalidParameterException) Code() string

Code returns the exception type name.

func (*InvalidParameterException) Error added in v1.28.0 

func (s *InvalidParameterException) Error() string

func (InvalidParameterException) GoString added in v1.28.0 

func (s InvalidParameterException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidParameterException) Message added in v1.28.0 

func (s *InvalidParameterException) Message() string

Message returns the exception's message.

func (*InvalidParameterException) OrigErr added in v1.28.0 

func (s *InvalidParameterException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidParameterException) RequestID added in v1.28.0 

func (s *InvalidParameterException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidParameterException) StatusCode added in v1.28.0 

func (s *InvalidParameterException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidParameterException) String added in v1.28.0 

func (s InvalidParameterException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LimitExceededException added in v1.28.0 

type LimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message returned by a LimitExceededException.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Thrown when the total number of user pools has exceeded a preset limit.

func (*LimitExceededException) Code added in v1.28.0 

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error added in v1.28.0 

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString added in v1.28.0 

func (s LimitExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LimitExceededException) Message added in v1.28.0 

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr added in v1.28.0 

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID added in v1.28.0 

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode added in v1.28.0 

func (s *LimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (LimitExceededException) String added in v1.28.0 

func (s LimitExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListIdentitiesInput 

type ListIdentitiesInput struct {

	// An optional boolean parameter that allows you to hide disabled identities.
	// If omitted, the ListIdentities API will include disabled identities in the
	// response.
	HideDisabled *bool `type:"boolean"`

	// An identity pool ID in the format REGION:GUID.
	//
	// IdentityPoolId is a required field
	IdentityPoolId *string `min:"1" type:"string" required:"true"`

	// The maximum number of identities to return.
	//
	// MaxResults is a required field
	MaxResults *int64 `min:"1" type:"integer" required:"true"`

	// A pagination token.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Input to the ListIdentities action.

func (ListIdentitiesInput) GoString added in v0.6.5 

func (s ListIdentitiesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListIdentitiesInput) SetHideDisabled added in v1.5.0 

func (s *ListIdentitiesInput) SetHideDisabled(v bool) *ListIdentitiesInput

SetHideDisabled sets the HideDisabled field's value.

func (*ListIdentitiesInput) SetIdentityPoolId added in v1.5.0 

func (s *ListIdentitiesInput) SetIdentityPoolId(v string) *ListIdentitiesInput

SetIdentityPoolId sets the IdentityPoolId field's value.

func (*ListIdentitiesInput) SetMaxResults added in v1.5.0 

func (s *ListIdentitiesInput) SetMaxResults(v int64) *ListIdentitiesInput

SetMaxResults sets the MaxResults field's value.

func (*ListIdentitiesInput) SetNextToken added in v1.5.0 

func (s *ListIdentitiesInput) SetNextToken(v string) *ListIdentitiesInput

SetNextToken sets the NextToken field's value.

func (ListIdentitiesInput) String added in v0.6.5 

func (s ListIdentitiesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListIdentitiesInput) Validate added in v1.1.21 

func (s *ListIdentitiesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListIdentitiesOutput 

type ListIdentitiesOutput struct {

	// An object containing a set of identities and associated mappings.
	Identities []*IdentityDescription `type:"list"`

	// An identity pool ID in the format REGION:GUID.
	IdentityPoolId *string `min:"1" type:"string"`

	// A pagination token.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The response to a ListIdentities request.

func (ListIdentitiesOutput) GoString added in v0.6.5 

func (s ListIdentitiesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListIdentitiesOutput) SetIdentities added in v1.5.0 

func (s *ListIdentitiesOutput) SetIdentities(v []*IdentityDescription) *ListIdentitiesOutput

SetIdentities sets the Identities field's value.

func (*ListIdentitiesOutput) SetIdentityPoolId added in v1.5.0 

func (s *ListIdentitiesOutput) SetIdentityPoolId(v string) *ListIdentitiesOutput

SetIdentityPoolId sets the IdentityPoolId field's value.

func (*ListIdentitiesOutput) SetNextToken added in v1.5.0 

func (s *ListIdentitiesOutput) SetNextToken(v string) *ListIdentitiesOutput

SetNextToken sets the NextToken field's value.

func (ListIdentitiesOutput) String added in v0.6.5 

func (s ListIdentitiesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListIdentityPoolsInput 

type ListIdentityPoolsInput struct {

	// The maximum number of identities to return.
	//
	// MaxResults is a required field
	MaxResults *int64 `min:"1" type:"integer" required:"true"`

	// A pagination token.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Input to the ListIdentityPools action.

func (ListIdentityPoolsInput) GoString added in v0.6.5 

func (s ListIdentityPoolsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListIdentityPoolsInput) SetMaxResults added in v1.5.0 

func (s *ListIdentityPoolsInput) SetMaxResults(v int64) *ListIdentityPoolsInput

SetMaxResults sets the MaxResults field's value.

func (*ListIdentityPoolsInput) SetNextToken added in v1.5.0 

func (s *ListIdentityPoolsInput) SetNextToken(v string) *ListIdentityPoolsInput

SetNextToken sets the NextToken field's value.

func (ListIdentityPoolsInput) String added in v0.6.5 

func (s ListIdentityPoolsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListIdentityPoolsInput) Validate added in v1.1.21 

func (s *ListIdentityPoolsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListIdentityPoolsOutput 

type ListIdentityPoolsOutput struct {

	// The identity pools returned by the ListIdentityPools action.
	IdentityPools []*IdentityPoolShortDescription `type:"list"`

	// A pagination token.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The result of a successful ListIdentityPools action.

func (ListIdentityPoolsOutput) GoString added in v0.6.5 

func (s ListIdentityPoolsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListIdentityPoolsOutput) SetIdentityPools added in v1.5.0 

func (s *ListIdentityPoolsOutput) SetIdentityPools(v []*IdentityPoolShortDescription) *ListIdentityPoolsOutput

SetIdentityPools sets the IdentityPools field's value.

func (*ListIdentityPoolsOutput) SetNextToken added in v1.5.0 

func (s *ListIdentityPoolsOutput) SetNextToken(v string) *ListIdentityPoolsOutput

SetNextToken sets the NextToken field's value.

func (ListIdentityPoolsOutput) String added in v0.6.5 

func (s ListIdentityPoolsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput added in v1.18.6 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the identity pool that the tags are assigned
	// to.
	//
	// ResourceArn is a required field
	ResourceArn *string `min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString added in v1.18.6 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceArn added in v1.18.6 

func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String added in v1.18.6 

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate added in v1.18.6 

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput added in v1.18.6 

type ListTagsForResourceOutput struct {

	// The tags that are assigned to the identity pool.
	Tags map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString added in v1.18.6 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags added in v1.18.6 

func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String added in v1.18.6 

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LookupDeveloperIdentityInput 

type LookupDeveloperIdentityInput struct {

	// 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.
	DeveloperUserIdentifier *string `min:"1" type:"string"`

	// A unique identifier in the format REGION:GUID.
	IdentityId *string `min:"1" type:"string"`

	// An identity pool ID in the format REGION:GUID.
	//
	// IdentityPoolId is a required field
	IdentityPoolId *string `min:"1" type:"string" required:"true"`

	// The maximum number of identities to return.
	MaxResults *int64 `min:"1" type:"integer"`

	// 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.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Input to the LookupDeveloperIdentityInput action.

func (LookupDeveloperIdentityInput) GoString added in v0.6.5 

func (s LookupDeveloperIdentityInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LookupDeveloperIdentityInput) SetDeveloperUserIdentifier added in v1.5.0 

func (s *LookupDeveloperIdentityInput) SetDeveloperUserIdentifier(v string) *LookupDeveloperIdentityInput

SetDeveloperUserIdentifier sets the DeveloperUserIdentifier field's value.

func (*LookupDeveloperIdentityInput) SetIdentityId added in v1.5.0 

func (s *LookupDeveloperIdentityInput) SetIdentityId(v string) *LookupDeveloperIdentityInput

SetIdentityId sets the IdentityId field's value.

func (*LookupDeveloperIdentityInput) SetIdentityPoolId added in v1.5.0 

func (s *LookupDeveloperIdentityInput) SetIdentityPoolId(v string) *LookupDeveloperIdentityInput

SetIdentityPoolId sets the IdentityPoolId field's value.

func (*LookupDeveloperIdentityInput) SetMaxResults added in v1.5.0 

func (s *LookupDeveloperIdentityInput) SetMaxResults(v int64) *LookupDeveloperIdentityInput

SetMaxResults sets the MaxResults field's value.

func (*LookupDeveloperIdentityInput) SetNextToken added in v1.5.0 

func (s *LookupDeveloperIdentityInput) SetNextToken(v string) *LookupDeveloperIdentityInput

SetNextToken sets the NextToken field's value.

func (LookupDeveloperIdentityInput) String added in v0.6.5 

func (s LookupDeveloperIdentityInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LookupDeveloperIdentityInput) Validate added in v1.1.21 

func (s *LookupDeveloperIdentityInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type LookupDeveloperIdentityOutput 

type LookupDeveloperIdentityOutput struct {

	// This is the list of developer user identifiers associated with an identity
	// ID. Cognito supports the association of multiple developer user identifiers
	// with an identity ID.
	DeveloperUserIdentifierList []*string `type:"list"`

	// A unique identifier in the format REGION:GUID.
	IdentityId *string `min:"1" type:"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.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Returned in response to a successful LookupDeveloperIdentity action.

func (LookupDeveloperIdentityOutput) GoString added in v0.6.5 

func (s LookupDeveloperIdentityOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LookupDeveloperIdentityOutput) SetDeveloperUserIdentifierList added in v1.5.0 

func (s *LookupDeveloperIdentityOutput) SetDeveloperUserIdentifierList(v []*string) *LookupDeveloperIdentityOutput

SetDeveloperUserIdentifierList sets the DeveloperUserIdentifierList field's value.

func (*LookupDeveloperIdentityOutput) SetIdentityId added in v1.5.0 

func (s *LookupDeveloperIdentityOutput) SetIdentityId(v string) *LookupDeveloperIdentityOutput

SetIdentityId sets the IdentityId field's value.

func (*LookupDeveloperIdentityOutput) SetNextToken added in v1.5.0 

func (s *LookupDeveloperIdentityOutput) SetNextToken(v string) *LookupDeveloperIdentityOutput

SetNextToken sets the NextToken field's value.

func (LookupDeveloperIdentityOutput) String added in v0.6.5 

func (s LookupDeveloperIdentityOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MappingRule added in v1.6.5 

type MappingRule struct {

	// The claim name that must be present in the token, for example, "isAdmin"
	// or "paid".
	//
	// Claim is a required field
	Claim *string `min:"1" type:"string" required:"true"`

	// The match condition that specifies how closely the claim value in the IdP
	// token must match Value.
	//
	// MatchType is a required field
	MatchType *string `type:"string" required:"true" enum:"MappingRuleMatchType"`

	// The role ARN.
	//
	// RoleARN is a required field
	RoleARN *string `min:"20" type:"string" required:"true"`

	// A brief string that the claim must match, for example, "paid" or "yes".
	//
	// Value is a required field
	Value *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A rule that maps a claim name, a claim value, and a match type to a role ARN.

func (MappingRule) GoString added in v1.6.5 

func (s MappingRule) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MappingRule) SetClaim added in v1.6.5 

func (s *MappingRule) SetClaim(v string) *MappingRule

SetClaim sets the Claim field's value.

func (*MappingRule) SetMatchType added in v1.6.5 

func (s *MappingRule) SetMatchType(v string) *MappingRule

SetMatchType sets the MatchType field's value.

func (*MappingRule) SetRoleARN added in v1.6.5 

func (s *MappingRule) SetRoleARN(v string) *MappingRule

SetRoleARN sets the RoleARN field's value.

func (*MappingRule) SetValue added in v1.6.5 

func (s *MappingRule) SetValue(v string) *MappingRule

SetValue sets the Value field's value.

func (MappingRule) String added in v1.6.5 

func (s MappingRule) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MappingRule) Validate added in v1.6.5 

func (s *MappingRule) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type MergeDeveloperIdentitiesInput 

type MergeDeveloperIdentitiesInput struct {

	// User identifier for the destination user. The value should be a DeveloperUserIdentifier.
	//
	// DestinationUserIdentifier is a required field
	DestinationUserIdentifier *string `min:"1" type:"string" required:"true"`

	// 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 (-).
	//
	// DeveloperProviderName is a required field
	DeveloperProviderName *string `min:"1" type:"string" required:"true"`

	// An identity pool ID in the format REGION:GUID.
	//
	// IdentityPoolId is a required field
	IdentityPoolId *string `min:"1" type:"string" required:"true"`

	// User identifier for the source user. The value should be a DeveloperUserIdentifier.
	//
	// SourceUserIdentifier is a required field
	SourceUserIdentifier *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input to the MergeDeveloperIdentities action.

func (MergeDeveloperIdentitiesInput) GoString added in v0.6.5 

func (s MergeDeveloperIdentitiesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MergeDeveloperIdentitiesInput) SetDestinationUserIdentifier added in v1.5.0 

func (s *MergeDeveloperIdentitiesInput) SetDestinationUserIdentifier(v string) *MergeDeveloperIdentitiesInput

SetDestinationUserIdentifier sets the DestinationUserIdentifier field's value.

func (*MergeDeveloperIdentitiesInput) SetDeveloperProviderName added in v1.5.0 

func (s *MergeDeveloperIdentitiesInput) SetDeveloperProviderName(v string) *MergeDeveloperIdentitiesInput

SetDeveloperProviderName sets the DeveloperProviderName field's value.

func (*MergeDeveloperIdentitiesInput) SetIdentityPoolId added in v1.5.0 

func (s *MergeDeveloperIdentitiesInput) SetIdentityPoolId(v string) *MergeDeveloperIdentitiesInput

SetIdentityPoolId sets the IdentityPoolId field's value.

func (*MergeDeveloperIdentitiesInput) SetSourceUserIdentifier added in v1.5.0 

func (s *MergeDeveloperIdentitiesInput) SetSourceUserIdentifier(v string) *MergeDeveloperIdentitiesInput

SetSourceUserIdentifier sets the SourceUserIdentifier field's value.

func (MergeDeveloperIdentitiesInput) String added in v0.6.5 

func (s MergeDeveloperIdentitiesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MergeDeveloperIdentitiesInput) Validate added in v1.1.21 

func (s *MergeDeveloperIdentitiesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type MergeDeveloperIdentitiesOutput 

type MergeDeveloperIdentitiesOutput struct {

	// A unique identifier in the format REGION:GUID.
	IdentityId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Returned in response to a successful MergeDeveloperIdentities action.

func (MergeDeveloperIdentitiesOutput) GoString added in v0.6.5 

func (s MergeDeveloperIdentitiesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MergeDeveloperIdentitiesOutput) SetIdentityId added in v1.5.0 

func (s *MergeDeveloperIdentitiesOutput) SetIdentityId(v string) *MergeDeveloperIdentitiesOutput

SetIdentityId sets the IdentityId field's value.

func (MergeDeveloperIdentitiesOutput) String added in v0.6.5 

func (s MergeDeveloperIdentitiesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NotAuthorizedException added in v1.28.0 

type NotAuthorizedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message returned by a NotAuthorizedException
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Thrown when a user is not authorized to access the requested resource.

func (*NotAuthorizedException) Code added in v1.28.0 

func (s *NotAuthorizedException) Code() string

Code returns the exception type name.

func (*NotAuthorizedException) Error added in v1.28.0 

func (s *NotAuthorizedException) Error() string

func (NotAuthorizedException) GoString added in v1.28.0 

func (s NotAuthorizedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NotAuthorizedException) Message added in v1.28.0 

func (s *NotAuthorizedException) Message() string

Message returns the exception's message.

func (*NotAuthorizedException) OrigErr added in v1.28.0 

func (s *NotAuthorizedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NotAuthorizedException) RequestID added in v1.28.0 

func (s *NotAuthorizedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NotAuthorizedException) StatusCode added in v1.28.0 

func (s *NotAuthorizedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (NotAuthorizedException) String added in v1.28.0 

func (s NotAuthorizedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Provider added in v1.1.19 

type Provider struct {

	// The client ID for the Amazon Cognito user pool.
	ClientId *string `min:"1" type:"string"`

	// The provider name for an Amazon Cognito user pool. For example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789.
	ProviderName *string `min:"1" type:"string"`

	// TRUE if server-side token validation is enabled for the identity provider’s
	// token.
	//
	// Once you set ServerSideTokenCheck to TRUE for an identity pool, that identity
	// pool will check with the integrated user pools to make sure that the user
	// has not been globally signed out or deleted before the identity pool provides
	// an OIDC token or AWS credentials for the user.
	//
	// If the user is signed out or deleted, the identity pool will return a 400
	// Not Authorized error.
	ServerSideTokenCheck *bool `type:"boolean"`
	// contains filtered or unexported fields
}

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

func (Provider) GoString added in v1.1.19 

func (s Provider) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Provider) SetClientId added in v1.5.0 

func (s *Provider) SetClientId(v string) *Provider

SetClientId sets the ClientId field's value.

func (*Provider) SetProviderName added in v1.5.0 

func (s *Provider) SetProviderName(v string) *Provider

SetProviderName sets the ProviderName field's value.

func (*Provider) SetServerSideTokenCheck added in v1.6.24 

func (s *Provider) SetServerSideTokenCheck(v bool) *Provider

SetServerSideTokenCheck sets the ServerSideTokenCheck field's value.

func (Provider) String added in v1.1.19 

func (s Provider) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Provider) Validate added in v1.1.21 

func (s *Provider) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResourceConflictException added in v1.28.0 

type ResourceConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message returned by a ResourceConflictException.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Thrown when a user tries to use a login which is already linked to another account.

func (*ResourceConflictException) Code added in v1.28.0 

func (s *ResourceConflictException) Code() string

Code returns the exception type name.

func (*ResourceConflictException) Error added in v1.28.0 

func (s *ResourceConflictException) Error() string

func (ResourceConflictException) GoString added in v1.28.0 

func (s ResourceConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceConflictException) Message added in v1.28.0 

func (s *ResourceConflictException) Message() string

Message returns the exception's message.

func (*ResourceConflictException) OrigErr added in v1.28.0 

func (s *ResourceConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceConflictException) RequestID added in v1.28.0 

func (s *ResourceConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceConflictException) StatusCode added in v1.28.0 

func (s *ResourceConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceConflictException) String added in v1.28.0 

func (s ResourceConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException added in v1.28.0 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message returned by a ResourceNotFoundException.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*ResourceNotFoundException) Code added in v1.28.0 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error added in v1.28.0 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString added in v1.28.0 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message added in v1.28.0 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr added in v1.28.0 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID added in v1.28.0 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode added in v1.28.0 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String added in v1.28.0 

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RoleMapping added in v1.6.5 

type RoleMapping struct {

	// If you specify Token or Rules as the Type, AmbiguousRoleResolution is required.
	//
	// Specifies the action to be taken if either no rules match the claim value
	// for the Rules type, or there is no cognito:preferred_role claim and there
	// are multiple cognito:roles matches for the Token type.
	AmbiguousRoleResolution *string `type:"string" enum:"AmbiguousRoleResolutionType"`

	// The rules to be used for mapping users to roles.
	//
	// If you specify Rules as the role mapping type, RulesConfiguration is required.
	RulesConfiguration *RulesConfigurationType `type:"structure"`

	// The role mapping type. Token will use cognito:roles and cognito:preferred_role
	// claims from the Cognito identity provider token to map groups to roles. Rules
	// will attempt to match claims from the token to map to a role.
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"RoleMappingType"`
	// contains filtered or unexported fields
}

A role mapping.

func (RoleMapping) GoString added in v1.6.5 

func (s RoleMapping) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RoleMapping) SetAmbiguousRoleResolution added in v1.6.5 

func (s *RoleMapping) SetAmbiguousRoleResolution(v string) *RoleMapping

SetAmbiguousRoleResolution sets the AmbiguousRoleResolution field's value.

func (*RoleMapping) SetRulesConfiguration added in v1.6.5 

func (s *RoleMapping) SetRulesConfiguration(v *RulesConfigurationType) *RoleMapping

SetRulesConfiguration sets the RulesConfiguration field's value.

func (*RoleMapping) SetType added in v1.6.5 

func (s *RoleMapping) SetType(v string) *RoleMapping

SetType sets the Type field's value.

func (RoleMapping) String added in v1.6.5 

func (s RoleMapping) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RoleMapping) Validate added in v1.6.5 

func (s *RoleMapping) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RulesConfigurationType added in v1.6.5 

type RulesConfigurationType struct {

	// An array of rules. You can specify up to 25 rules per identity provider.
	//
	// Rules are evaluated in order. The first one to match specifies the role.
	//
	// Rules is a required field
	Rules []*MappingRule `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

A container for rules.

func (RulesConfigurationType) GoString added in v1.6.5 

func (s RulesConfigurationType) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RulesConfigurationType) SetRules added in v1.6.5 

func (s *RulesConfigurationType) SetRules(v []*MappingRule) *RulesConfigurationType

SetRules sets the Rules field's value.

func (RulesConfigurationType) String added in v1.6.5 

func (s RulesConfigurationType) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RulesConfigurationType) Validate added in v1.6.5 

func (s *RulesConfigurationType) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SetIdentityPoolRolesInput 

type SetIdentityPoolRolesInput struct {

	// An identity pool ID in the format REGION:GUID.
	//
	// IdentityPoolId is a required field
	IdentityPoolId *string `min:"1" type:"string" required:"true"`

	// 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.
	RoleMappings map[string]*RoleMapping `type:"map"`

	// 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.
	//
	// Roles is a required field
	Roles map[string]*string `type:"map" required:"true"`
	// contains filtered or unexported fields
}

Input to the SetIdentityPoolRoles action.

func (SetIdentityPoolRolesInput) GoString added in v0.6.5 

func (s SetIdentityPoolRolesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SetIdentityPoolRolesInput) SetIdentityPoolId added in v1.5.0 

func (s *SetIdentityPoolRolesInput) SetIdentityPoolId(v string) *SetIdentityPoolRolesInput

SetIdentityPoolId sets the IdentityPoolId field's value.

func (*SetIdentityPoolRolesInput) SetRoleMappings added in v1.6.5 

func (s *SetIdentityPoolRolesInput) SetRoleMappings(v map[string]*RoleMapping) *SetIdentityPoolRolesInput

SetRoleMappings sets the RoleMappings field's value.

func (*SetIdentityPoolRolesInput) SetRoles added in v1.5.0 

func (s *SetIdentityPoolRolesInput) SetRoles(v map[string]*string) *SetIdentityPoolRolesInput

SetRoles sets the Roles field's value.

func (SetIdentityPoolRolesInput) String added in v0.6.5 

func (s SetIdentityPoolRolesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SetIdentityPoolRolesInput) Validate added in v1.1.21 

func (s *SetIdentityPoolRolesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SetIdentityPoolRolesOutput 

type SetIdentityPoolRolesOutput struct {
	// contains filtered or unexported fields
}

func (SetIdentityPoolRolesOutput) GoString added in v0.6.5 

func (s SetIdentityPoolRolesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (SetIdentityPoolRolesOutput) String added in v0.6.5 

func (s SetIdentityPoolRolesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SetPrincipalTagAttributeMapInput added in v1.36.27 

type SetPrincipalTagAttributeMapInput struct {

	// The ID of the Identity Pool you want to set attribute mappings for.
	//
	// IdentityPoolId is a required field
	IdentityPoolId *string `min:"1" type:"string" required:"true"`

	// The provider name you want to use for attribute mappings.
	//
	// IdentityProviderName is a required field
	IdentityProviderName *string `min:"1" type:"string" required:"true"`

	// You can use this operation to add principal tags.
	PrincipalTags map[string]*string `type:"map"`

	// You can use this operation to use default (username and clientID) attribute
	// mappings.
	UseDefaults *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (SetPrincipalTagAttributeMapInput) GoString added in v1.36.27 

func (s SetPrincipalTagAttributeMapInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SetPrincipalTagAttributeMapInput) SetIdentityPoolId added in v1.36.27 

func (s *SetPrincipalTagAttributeMapInput) SetIdentityPoolId(v string) *SetPrincipalTagAttributeMapInput

SetIdentityPoolId sets the IdentityPoolId field's value.

func (*SetPrincipalTagAttributeMapInput) SetIdentityProviderName added in v1.36.27 

func (s *SetPrincipalTagAttributeMapInput) SetIdentityProviderName(v string) *SetPrincipalTagAttributeMapInput

SetIdentityProviderName sets the IdentityProviderName field's value.

func (*SetPrincipalTagAttributeMapInput) SetPrincipalTags added in v1.36.27 

func (s *SetPrincipalTagAttributeMapInput) SetPrincipalTags(v map[string]*string) *SetPrincipalTagAttributeMapInput

SetPrincipalTags sets the PrincipalTags field's value.

func (*SetPrincipalTagAttributeMapInput) SetUseDefaults added in v1.36.27 

func (s *SetPrincipalTagAttributeMapInput) SetUseDefaults(v bool) *SetPrincipalTagAttributeMapInput

SetUseDefaults sets the UseDefaults field's value.

func (SetPrincipalTagAttributeMapInput) String added in v1.36.27 

func (s SetPrincipalTagAttributeMapInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SetPrincipalTagAttributeMapInput) Validate added in v1.36.27 

func (s *SetPrincipalTagAttributeMapInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SetPrincipalTagAttributeMapOutput added in v1.36.27 

type SetPrincipalTagAttributeMapOutput struct {

	// The ID of the Identity Pool you want to set attribute mappings for.
	IdentityPoolId *string `min:"1" type:"string"`

	// The provider name you want to use for attribute mappings.
	IdentityProviderName *string `min:"1" type:"string"`

	// You can use this operation to add principal tags. The PrincipalTagsoperation
	// enables you to reference user attributes in your IAM permissions policy.
	PrincipalTags map[string]*string `type:"map"`

	// You can use this operation to select default (username and clientID) attribute
	// mappings.
	UseDefaults *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (SetPrincipalTagAttributeMapOutput) GoString added in v1.36.27 

func (s SetPrincipalTagAttributeMapOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SetPrincipalTagAttributeMapOutput) SetIdentityPoolId added in v1.36.27 

func (s *SetPrincipalTagAttributeMapOutput) SetIdentityPoolId(v string) *SetPrincipalTagAttributeMapOutput

SetIdentityPoolId sets the IdentityPoolId field's value.

func (*SetPrincipalTagAttributeMapOutput) SetIdentityProviderName added in v1.36.27 

func (s *SetPrincipalTagAttributeMapOutput) SetIdentityProviderName(v string) *SetPrincipalTagAttributeMapOutput

SetIdentityProviderName sets the IdentityProviderName field's value.

func (*SetPrincipalTagAttributeMapOutput) SetPrincipalTags added in v1.36.27 

func (s *SetPrincipalTagAttributeMapOutput) SetPrincipalTags(v map[string]*string) *SetPrincipalTagAttributeMapOutput

SetPrincipalTags sets the PrincipalTags field's value.

func (*SetPrincipalTagAttributeMapOutput) SetUseDefaults added in v1.36.27 

func (s *SetPrincipalTagAttributeMapOutput) SetUseDefaults(v bool) *SetPrincipalTagAttributeMapOutput

SetUseDefaults sets the UseDefaults field's value.

func (SetPrincipalTagAttributeMapOutput) String added in v1.36.27 

func (s SetPrincipalTagAttributeMapOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TagResourceInput added in v1.18.6 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the identity pool.
	//
	// ResourceArn is a required field
	ResourceArn *string `min:"20" type:"string" required:"true"`

	// The tags to assign to the identity pool.
	//
	// Tags is a required field
	Tags map[string]*string `type:"map" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString added in v1.18.6 

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceArn added in v1.18.6 

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags added in v1.18.6 

func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String added in v1.18.6 

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate added in v1.18.6 

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput added in v1.18.6 

type TagResourceOutput struct {
	// contains filtered or unexported fields
}

func (TagResourceOutput) GoString added in v1.18.6 

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String added in v1.18.6 

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TooManyRequestsException added in v1.28.0 

type TooManyRequestsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// Message returned by a TooManyRequestsException
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Thrown when a request is throttled.

func (*TooManyRequestsException) Code added in v1.28.0 

func (s *TooManyRequestsException) Code() string

Code returns the exception type name.

func (*TooManyRequestsException) Error added in v1.28.0 

func (s *TooManyRequestsException) Error() string

func (TooManyRequestsException) GoString added in v1.28.0 

func (s TooManyRequestsException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TooManyRequestsException) Message added in v1.28.0 

func (s *TooManyRequestsException) Message() string

Message returns the exception's message.

func (*TooManyRequestsException) OrigErr added in v1.28.0 

func (s *TooManyRequestsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TooManyRequestsException) RequestID added in v1.28.0 

func (s *TooManyRequestsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TooManyRequestsException) StatusCode added in v1.28.0 

func (s *TooManyRequestsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (TooManyRequestsException) String added in v1.28.0 

func (s TooManyRequestsException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UnlinkDeveloperIdentityInput 

type UnlinkDeveloperIdentityInput struct {

	// The "domain" by which Cognito will refer to your users.
	//
	// DeveloperProviderName is a required field
	DeveloperProviderName *string `min:"1" type:"string" required:"true"`

	// A unique ID used by your backend authentication process to identify a user.
	//
	// DeveloperUserIdentifier is a required field
	DeveloperUserIdentifier *string `min:"1" type:"string" required:"true"`

	// A unique identifier in the format REGION:GUID.
	//
	// IdentityId is a required field
	IdentityId *string `min:"1" type:"string" required:"true"`

	// An identity pool ID in the format REGION:GUID.
	//
	// IdentityPoolId is a required field
	IdentityPoolId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input to the UnlinkDeveloperIdentity action.

func (UnlinkDeveloperIdentityInput) GoString added in v0.6.5 

func (s UnlinkDeveloperIdentityInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UnlinkDeveloperIdentityInput) SetDeveloperProviderName added in v1.5.0 

func (s *UnlinkDeveloperIdentityInput) SetDeveloperProviderName(v string) *UnlinkDeveloperIdentityInput

SetDeveloperProviderName sets the DeveloperProviderName field's value.

func (*UnlinkDeveloperIdentityInput) SetDeveloperUserIdentifier added in v1.5.0 

func (s *UnlinkDeveloperIdentityInput) SetDeveloperUserIdentifier(v string) *UnlinkDeveloperIdentityInput

SetDeveloperUserIdentifier sets the DeveloperUserIdentifier field's value.

func (*UnlinkDeveloperIdentityInput) SetIdentityId added in v1.5.0 

func (s *UnlinkDeveloperIdentityInput) SetIdentityId(v string) *UnlinkDeveloperIdentityInput

SetIdentityId sets the IdentityId field's value.

func (*UnlinkDeveloperIdentityInput) SetIdentityPoolId added in v1.5.0 

func (s *UnlinkDeveloperIdentityInput) SetIdentityPoolId(v string) *UnlinkDeveloperIdentityInput

SetIdentityPoolId sets the IdentityPoolId field's value.

func (UnlinkDeveloperIdentityInput) String added in v0.6.5 

func (s UnlinkDeveloperIdentityInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UnlinkDeveloperIdentityInput) Validate added in v1.1.21 

func (s *UnlinkDeveloperIdentityInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UnlinkDeveloperIdentityOutput 

type UnlinkDeveloperIdentityOutput struct {
	// contains filtered or unexported fields
}

func (UnlinkDeveloperIdentityOutput) GoString added in v0.6.5 

func (s UnlinkDeveloperIdentityOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UnlinkDeveloperIdentityOutput) String added in v0.6.5 

func (s UnlinkDeveloperIdentityOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UnlinkIdentityInput 

type UnlinkIdentityInput struct {

	// A unique identifier in the format REGION:GUID.
	//
	// IdentityId is a required field
	IdentityId *string `min:"1" type:"string" required:"true"`

	// A set of optional name-value pairs that map provider names to provider tokens.
	//
	// Logins is a required field
	Logins map[string]*string `type:"map" required:"true"`

	// Provider names to unlink from this identity.
	//
	// LoginsToRemove is a required field
	LoginsToRemove []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Input to the UnlinkIdentity action.

func (UnlinkIdentityInput) GoString added in v0.6.5 

func (s UnlinkIdentityInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UnlinkIdentityInput) SetIdentityId added in v1.5.0 

func (s *UnlinkIdentityInput) SetIdentityId(v string) *UnlinkIdentityInput

SetIdentityId sets the IdentityId field's value.

func (*UnlinkIdentityInput) SetLogins added in v1.5.0 

func (s *UnlinkIdentityInput) SetLogins(v map[string]*string) *UnlinkIdentityInput

SetLogins sets the Logins field's value.

func (*UnlinkIdentityInput) SetLoginsToRemove added in v1.5.0 

func (s *UnlinkIdentityInput) SetLoginsToRemove(v []*string) *UnlinkIdentityInput

SetLoginsToRemove sets the LoginsToRemove field's value.

func (UnlinkIdentityInput) String added in v0.6.5 

func (s UnlinkIdentityInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UnlinkIdentityInput) Validate added in v1.1.21 

func (s *UnlinkIdentityInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UnlinkIdentityOutput 

type UnlinkIdentityOutput struct {
	// contains filtered or unexported fields
}

func (UnlinkIdentityOutput) GoString added in v0.6.5 

func (s UnlinkIdentityOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UnlinkIdentityOutput) String added in v0.6.5 

func (s UnlinkIdentityOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UnprocessedIdentityId added in v0.9.5 

type UnprocessedIdentityId struct {

	// The error code indicating the type of error that occurred.
	ErrorCode *string `type:"string" enum:"ErrorCode"`

	// A unique identifier in the format REGION:GUID.
	IdentityId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

An array of UnprocessedIdentityId objects, each of which contains an ErrorCode and IdentityId.

func (UnprocessedIdentityId) GoString added in v0.9.5 

func (s UnprocessedIdentityId) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UnprocessedIdentityId) SetErrorCode added in v1.5.0 

func (s *UnprocessedIdentityId) SetErrorCode(v string) *UnprocessedIdentityId

SetErrorCode sets the ErrorCode field's value.

func (*UnprocessedIdentityId) SetIdentityId added in v1.5.0 

func (s *UnprocessedIdentityId) SetIdentityId(v string) *UnprocessedIdentityId

SetIdentityId sets the IdentityId field's value.

func (UnprocessedIdentityId) String added in v0.9.5 

func (s UnprocessedIdentityId) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput added in v1.18.6 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the identity pool.
	//
	// ResourceArn is a required field
	ResourceArn *string `min:"20" type:"string" required:"true"`

	// The keys of the tags to remove from the user pool.
	//
	// TagKeys is a required field
	TagKeys []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString added in v1.18.6 

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceArn added in v1.18.6 

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys added in v1.18.6 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String added in v1.18.6 

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate added in v1.18.6 

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput added in v1.18.6 

type UntagResourceOutput struct {
	// contains filtered or unexported fields
}

func (UntagResourceOutput) GoString added in v1.18.6 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String added in v1.18.6 

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Source Files

View all Source files

Directories

Path Synopsis
Package cognitoidentityiface provides an interface to enable mocking the Amazon Cognito Identity service client for testing your code.
 Package cognitoidentityiface provides an interface to enable mocking the Amazon Cognito Identity service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.