cognitoidentity

package
v0.11.0 Latest Latest
Warning

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

Go to latest
Published: Aug 23, 2019 License: Apache-2.0 Imports: 8 Imported by: 63

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 use 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 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 (
	ServiceName = "Amazon Cognito Identity" // Service's name
	ServiceID   = "CognitoIdentity"         // Service's identifier
	EndpointsID = "cognito-identity"        // Service's Endpoint identifier
)
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"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AmbiguousRoleResolutionType

type AmbiguousRoleResolutionType string
const (
	AmbiguousRoleResolutionTypeAuthenticatedRole AmbiguousRoleResolutionType = "AuthenticatedRole"
	AmbiguousRoleResolutionTypeDeny              AmbiguousRoleResolutionType = "Deny"
)

Enum values for AmbiguousRoleResolutionType

func (AmbiguousRoleResolutionType) MarshalValue added in v0.3.0

func (enum AmbiguousRoleResolutionType) MarshalValue() (string, error)

func (AmbiguousRoleResolutionType) MarshalValueBuf added in v0.3.0

func (enum AmbiguousRoleResolutionType) MarshalValueBuf(b []byte) ([]byte, error)

type Client added in v0.9.0

type Client struct {
	*aws.Client
}

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

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

func New

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example:

// Create a client from just a config.
svc := cognitoidentity.New(myConfig)

func (*Client) CreateIdentityPoolRequest added in v0.9.0

func (c *Client) CreateIdentityPoolRequest(input *CreateIdentityPoolInput) CreateIdentityPoolRequest

CreateIdentityPoolRequest returns a request value for making API operation for Amazon Cognito Identity.

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

  • Facebook: graph.facebook.com

  • Google: accounts.google.com

  • Amazon: www.amazon.com

  • Twitter: api.twitter.com

  • Digits: www.digits.com

You must use AWS Developer credentials to call this API.

// Example sending a request using CreateIdentityPoolRequest.
req := client.CreateIdentityPoolRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DeleteIdentitiesRequest added in v0.9.0

func (c *Client) DeleteIdentitiesRequest(input *DeleteIdentitiesInput) DeleteIdentitiesRequest

DeleteIdentitiesRequest returns a request value for making 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.

// Example sending a request using DeleteIdentitiesRequest.
req := client.DeleteIdentitiesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DeleteIdentityPoolRequest added in v0.9.0

func (c *Client) DeleteIdentityPoolRequest(input *DeleteIdentityPoolInput) DeleteIdentityPoolRequest

DeleteIdentityPoolRequest returns a request value for making 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.

// Example sending a request using DeleteIdentityPoolRequest.
req := client.DeleteIdentityPoolRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribeIdentityPoolRequest added in v0.9.0

func (c *Client) DescribeIdentityPoolRequest(input *DescribeIdentityPoolInput) DescribeIdentityPoolRequest

DescribeIdentityPoolRequest returns a request value for making 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.

// Example sending a request using DescribeIdentityPoolRequest.
req := client.DescribeIdentityPoolRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribeIdentityRequest added in v0.9.0

func (c *Client) DescribeIdentityRequest(input *DescribeIdentityInput) DescribeIdentityRequest

DescribeIdentityRequest returns a request value for making 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.

// Example sending a request using DescribeIdentityRequest.
req := client.DescribeIdentityRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetCredentialsForIdentityRequest added in v0.9.0

func (c *Client) GetCredentialsForIdentityRequest(input *GetCredentialsForIdentityInput) GetCredentialsForIdentityRequest

GetCredentialsForIdentityRequest returns a request value for making 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.

// Example sending a request using GetCredentialsForIdentityRequest.
req := client.GetCredentialsForIdentityRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetIdRequest added in v0.9.0

func (c *Client) GetIdRequest(input *GetIdInput) GetIdRequest

GetIdRequest returns a request value for making 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.

// Example sending a request using GetIdRequest.
req := client.GetIdRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetIdentityPoolRolesRequest added in v0.9.0

func (c *Client) GetIdentityPoolRolesRequest(input *GetIdentityPoolRolesInput) GetIdentityPoolRolesRequest

GetIdentityPoolRolesRequest returns a request value for making API operation for Amazon Cognito Identity.

Gets the roles for an identity pool.

You must use AWS Developer credentials to call this API.

// Example sending a request using GetIdentityPoolRolesRequest.
req := client.GetIdentityPoolRolesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetOpenIdTokenForDeveloperIdentityRequest added in v0.9.0

func (c *Client) GetOpenIdTokenForDeveloperIdentityRequest(input *GetOpenIdTokenForDeveloperIdentityInput) GetOpenIdTokenForDeveloperIdentityRequest

GetOpenIdTokenForDeveloperIdentityRequest returns a request value for making 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.

// Example sending a request using GetOpenIdTokenForDeveloperIdentityRequest.
req := client.GetOpenIdTokenForDeveloperIdentityRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetOpenIdTokenRequest added in v0.9.0

func (c *Client) GetOpenIdTokenRequest(input *GetOpenIdTokenInput) GetOpenIdTokenRequest

GetOpenIdTokenRequest returns a request value for making 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.

// Example sending a request using GetOpenIdTokenRequest.
req := client.GetOpenIdTokenRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) ListIdentitiesRequest added in v0.9.0

func (c *Client) ListIdentitiesRequest(input *ListIdentitiesInput) ListIdentitiesRequest

ListIdentitiesRequest returns a request value for making API operation for Amazon Cognito Identity.

Lists the identities in an identity pool.

You must use AWS Developer credentials to call this API.

// Example sending a request using ListIdentitiesRequest.
req := client.ListIdentitiesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) ListIdentityPoolsRequest added in v0.9.0

func (c *Client) ListIdentityPoolsRequest(input *ListIdentityPoolsInput) ListIdentityPoolsRequest

ListIdentityPoolsRequest returns a request value for making 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.

// Example sending a request using ListIdentityPoolsRequest.
req := client.ListIdentityPoolsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) ListTagsForResourceRequest added in v0.9.0

func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest

ListTagsForResourceRequest returns a request value for making 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.

// Example sending a request using ListTagsForResourceRequest.
req := client.ListTagsForResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/ListTagsForResource

func (*Client) LookupDeveloperIdentityRequest added in v0.9.0

func (c *Client) LookupDeveloperIdentityRequest(input *LookupDeveloperIdentityInput) LookupDeveloperIdentityRequest

LookupDeveloperIdentityRequest returns a request value for making 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.

// Example sending a request using LookupDeveloperIdentityRequest.
req := client.LookupDeveloperIdentityRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) MergeDeveloperIdentitiesRequest added in v0.9.0

func (c *Client) MergeDeveloperIdentitiesRequest(input *MergeDeveloperIdentitiesInput) MergeDeveloperIdentitiesRequest

MergeDeveloperIdentitiesRequest returns a request value for making 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.

// Example sending a request using MergeDeveloperIdentitiesRequest.
req := client.MergeDeveloperIdentitiesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) SetIdentityPoolRolesRequest added in v0.9.0

func (c *Client) SetIdentityPoolRolesRequest(input *SetIdentityPoolRolesInput) SetIdentityPoolRolesRequest

SetIdentityPoolRolesRequest returns a request value for making 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.

// Example sending a request using SetIdentityPoolRolesRequest.
req := client.SetIdentityPoolRolesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) TagResourceRequest added in v0.9.0

func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest

TagResourceRequest returns a request value for making API operation for Amazon Cognito Identity.

Assigns a set of tags to an 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.

// Example sending a request using TagResourceRequest.
req := client.TagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/TagResource

func (*Client) UnlinkDeveloperIdentityRequest added in v0.9.0

func (c *Client) UnlinkDeveloperIdentityRequest(input *UnlinkDeveloperIdentityInput) UnlinkDeveloperIdentityRequest

UnlinkDeveloperIdentityRequest returns a request value for making 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.

// Example sending a request using UnlinkDeveloperIdentityRequest.
req := client.UnlinkDeveloperIdentityRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) UnlinkIdentityRequest added in v0.9.0

func (c *Client) UnlinkIdentityRequest(input *UnlinkIdentityInput) UnlinkIdentityRequest

UnlinkIdentityRequest returns a request value for making 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.

// Example sending a request using UnlinkIdentityRequest.
req := client.UnlinkIdentityRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) UntagResourceRequest added in v0.9.0

func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest

UntagResourceRequest returns a request value for making API operation for Amazon Cognito Identity.

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

// Example sending a request using UntagResourceRequest.
req := client.UntagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/UntagResource

func (*Client) UpdateIdentityPoolRequest added in v0.9.0

func (c *Client) UpdateIdentityPoolRequest(input *UpdateIdentityPoolInput) UpdateIdentityPoolRequest

UpdateIdentityPoolRequest returns a request value for making API operation for Amazon Cognito Identity.

Updates an identity pool.

You must use AWS Developer credentials to call this API.

// Example sending a request using UpdateIdentityPoolRequest.
req := client.UpdateIdentityPoolRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

type CognitoIdentityProvider added in v0.9.0

type CognitoIdentityProvider 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/CognitoIdentityProvider

func (CognitoIdentityProvider) String added in v0.9.0

func (s CognitoIdentityProvider) String() string

String returns the string representation

func (*CognitoIdentityProvider) Validate added in v0.9.0

func (s *CognitoIdentityProvider) Validate() error

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

type CreateIdentityPoolInput

type CreateIdentityPoolInput struct {

	// 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 []CognitoIdentityProvider `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"`

	// A list of OpendID Connect provider ARNs.
	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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/CreateIdentityPoolInput

func (CreateIdentityPoolInput) String

func (s CreateIdentityPoolInput) String() string

String returns the string representation

func (*CreateIdentityPoolInput) Validate

func (s *CreateIdentityPoolInput) Validate() error

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

type CreateIdentityPoolOutput added in v0.9.0

type CreateIdentityPoolOutput struct {

	// 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 []CognitoIdentityProvider `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"`

	// A list of OpendID Connect provider ARNs.
	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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/IdentityPool

func (CreateIdentityPoolOutput) String added in v0.9.0

func (s CreateIdentityPoolOutput) String() string

String returns the string representation

type CreateIdentityPoolRequest

type CreateIdentityPoolRequest struct {
	*aws.Request
	Input *CreateIdentityPoolInput
	Copy  func(*CreateIdentityPoolInput) CreateIdentityPoolRequest
}

CreateIdentityPoolRequest is the request type for the CreateIdentityPool API operation.

func (CreateIdentityPoolRequest) Send

Send marshals and sends the CreateIdentityPool API request.

type CreateIdentityPoolResponse added in v0.9.0

type CreateIdentityPoolResponse struct {
	*CreateIdentityPoolOutput
	// contains filtered or unexported fields
}

CreateIdentityPoolResponse is the response type for the CreateIdentityPool API operation.

func (*CreateIdentityPoolResponse) SDKResponseMetdata added in v0.9.0

func (r *CreateIdentityPoolResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateIdentityPool request.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/Credentials

func (Credentials) String

func (s Credentials) String() string

String returns the string representation

type DeleteIdentitiesInput

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/DeleteIdentitiesInput

func (DeleteIdentitiesInput) String

func (s DeleteIdentitiesInput) String() string

String returns the string representation

func (*DeleteIdentitiesInput) Validate

func (s *DeleteIdentitiesInput) Validate() error

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

type DeleteIdentitiesOutput

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/DeleteIdentitiesResponse

func (DeleteIdentitiesOutput) String

func (s DeleteIdentitiesOutput) String() string

String returns the string representation

type DeleteIdentitiesRequest

type DeleteIdentitiesRequest struct {
	*aws.Request
	Input *DeleteIdentitiesInput
	Copy  func(*DeleteIdentitiesInput) DeleteIdentitiesRequest
}

DeleteIdentitiesRequest is the request type for the DeleteIdentities API operation.

func (DeleteIdentitiesRequest) Send

Send marshals and sends the DeleteIdentities API request.

type DeleteIdentitiesResponse added in v0.9.0

type DeleteIdentitiesResponse struct {
	*DeleteIdentitiesOutput
	// contains filtered or unexported fields
}

DeleteIdentitiesResponse is the response type for the DeleteIdentities API operation.

func (*DeleteIdentitiesResponse) SDKResponseMetdata added in v0.9.0

func (r *DeleteIdentitiesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteIdentities request.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/DeleteIdentityPoolInput

func (DeleteIdentityPoolInput) String

func (s DeleteIdentityPoolInput) String() string

String returns the string representation

func (*DeleteIdentityPoolInput) Validate

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/DeleteIdentityPoolOutput

func (DeleteIdentityPoolOutput) String

func (s DeleteIdentityPoolOutput) String() string

String returns the string representation

type DeleteIdentityPoolRequest

type DeleteIdentityPoolRequest struct {
	*aws.Request
	Input *DeleteIdentityPoolInput
	Copy  func(*DeleteIdentityPoolInput) DeleteIdentityPoolRequest
}

DeleteIdentityPoolRequest is the request type for the DeleteIdentityPool API operation.

func (DeleteIdentityPoolRequest) Send

Send marshals and sends the DeleteIdentityPool API request.

type DeleteIdentityPoolResponse added in v0.9.0

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

DeleteIdentityPoolResponse is the response type for the DeleteIdentityPool API operation.

func (*DeleteIdentityPoolResponse) SDKResponseMetdata added in v0.9.0

func (r *DeleteIdentityPoolResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteIdentityPool request.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/DescribeIdentityInput

func (DescribeIdentityInput) String

func (s DescribeIdentityInput) String() string

String returns the string representation

func (*DescribeIdentityInput) Validate

func (s *DescribeIdentityInput) Validate() error

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

type DescribeIdentityOutput

type DescribeIdentityOutput 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/IdentityDescription

func (DescribeIdentityOutput) String

func (s DescribeIdentityOutput) String() string

String returns the string representation

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/DescribeIdentityPoolInput

func (DescribeIdentityPoolInput) String

func (s DescribeIdentityPoolInput) String() string

String returns the string representation

func (*DescribeIdentityPoolInput) Validate

func (s *DescribeIdentityPoolInput) Validate() error

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

type DescribeIdentityPoolOutput added in v0.9.0

type DescribeIdentityPoolOutput struct {

	// 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 []CognitoIdentityProvider `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"`

	// A list of OpendID Connect provider ARNs.
	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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/IdentityPool

func (DescribeIdentityPoolOutput) String added in v0.9.0

String returns the string representation

type DescribeIdentityPoolRequest

type DescribeIdentityPoolRequest struct {
	*aws.Request
	Input *DescribeIdentityPoolInput
	Copy  func(*DescribeIdentityPoolInput) DescribeIdentityPoolRequest
}

DescribeIdentityPoolRequest is the request type for the DescribeIdentityPool API operation.

func (DescribeIdentityPoolRequest) Send

Send marshals and sends the DescribeIdentityPool API request.

type DescribeIdentityPoolResponse added in v0.9.0

type DescribeIdentityPoolResponse struct {
	*DescribeIdentityPoolOutput
	// contains filtered or unexported fields
}

DescribeIdentityPoolResponse is the response type for the DescribeIdentityPool API operation.

func (*DescribeIdentityPoolResponse) SDKResponseMetdata added in v0.9.0

func (r *DescribeIdentityPoolResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeIdentityPool request.

type DescribeIdentityRequest

type DescribeIdentityRequest struct {
	*aws.Request
	Input *DescribeIdentityInput
	Copy  func(*DescribeIdentityInput) DescribeIdentityRequest
}

DescribeIdentityRequest is the request type for the DescribeIdentity API operation.

func (DescribeIdentityRequest) Send

Send marshals and sends the DescribeIdentity API request.

type DescribeIdentityResponse added in v0.9.0

type DescribeIdentityResponse struct {
	*DescribeIdentityOutput
	// contains filtered or unexported fields
}

DescribeIdentityResponse is the response type for the DescribeIdentity API operation.

func (*DescribeIdentityResponse) SDKResponseMetdata added in v0.9.0

func (r *DescribeIdentityResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeIdentity request.

type ErrorCode

type ErrorCode string
const (
	ErrorCodeAccessDenied        ErrorCode = "AccessDenied"
	ErrorCodeInternalServerError ErrorCode = "InternalServerError"
)

Enum values for ErrorCode

func (ErrorCode) MarshalValue added in v0.3.0

func (enum ErrorCode) MarshalValue() (string, error)

func (ErrorCode) MarshalValueBuf added in v0.3.0

func (enum ErrorCode) MarshalValueBuf(b []byte) ([]byte, error)

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 (http://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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/GetCredentialsForIdentityInput

func (GetCredentialsForIdentityInput) String

String returns the string representation

func (*GetCredentialsForIdentityInput) Validate

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/GetCredentialsForIdentityResponse

func (GetCredentialsForIdentityOutput) String

String returns the string representation

type GetCredentialsForIdentityRequest

type GetCredentialsForIdentityRequest struct {
	*aws.Request
	Input *GetCredentialsForIdentityInput
	Copy  func(*GetCredentialsForIdentityInput) GetCredentialsForIdentityRequest
}

GetCredentialsForIdentityRequest is the request type for the GetCredentialsForIdentity API operation.

func (GetCredentialsForIdentityRequest) Send

Send marshals and sends the GetCredentialsForIdentity API request.

type GetCredentialsForIdentityResponse added in v0.9.0

type GetCredentialsForIdentityResponse struct {
	*GetCredentialsForIdentityOutput
	// contains filtered or unexported fields
}

GetCredentialsForIdentityResponse is the response type for the GetCredentialsForIdentity API operation.

func (*GetCredentialsForIdentityResponse) SDKResponseMetdata added in v0.9.0

func (r *GetCredentialsForIdentityResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetCredentialsForIdentity request.

type GetIdInput

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/GetIdInput

func (GetIdInput) String

func (s GetIdInput) String() string

String returns the string representation

func (*GetIdInput) Validate

func (s *GetIdInput) Validate() error

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

type GetIdOutput

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/GetIdResponse

func (GetIdOutput) String

func (s GetIdOutput) String() string

String returns the string representation

type GetIdRequest

type GetIdRequest struct {
	*aws.Request
	Input *GetIdInput
	Copy  func(*GetIdInput) GetIdRequest
}

GetIdRequest is the request type for the GetId API operation.

func (GetIdRequest) Send

Send marshals and sends the GetId API request.

type GetIdResponse added in v0.9.0

type GetIdResponse struct {
	*GetIdOutput
	// contains filtered or unexported fields
}

GetIdResponse is the response type for the GetId API operation.

func (*GetIdResponse) SDKResponseMetdata added in v0.9.0

func (r *GetIdResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetId request.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/GetIdentityPoolRolesInput

func (GetIdentityPoolRolesInput) String

func (s GetIdentityPoolRolesInput) String() string

String returns the string representation

func (*GetIdentityPoolRolesInput) Validate

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/GetIdentityPoolRolesResponse

func (GetIdentityPoolRolesOutput) String

String returns the string representation

type GetIdentityPoolRolesRequest

type GetIdentityPoolRolesRequest struct {
	*aws.Request
	Input *GetIdentityPoolRolesInput
	Copy  func(*GetIdentityPoolRolesInput) GetIdentityPoolRolesRequest
}

GetIdentityPoolRolesRequest is the request type for the GetIdentityPoolRoles API operation.

func (GetIdentityPoolRolesRequest) Send

Send marshals and sends the GetIdentityPoolRoles API request.

type GetIdentityPoolRolesResponse added in v0.9.0

type GetIdentityPoolRolesResponse struct {
	*GetIdentityPoolRolesOutput
	// contains filtered or unexported fields
}

GetIdentityPoolRolesResponse is the response type for the GetIdentityPoolRoles API operation.

func (*GetIdentityPoolRolesResponse) SDKResponseMetdata added in v0.9.0

func (r *GetIdentityPoolRolesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetIdentityPoolRoles request.

type GetOpenIdTokenForDeveloperIdentityInput

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"`

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

Input to the GetOpenIdTokenForDeveloperIdentity action. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/GetOpenIdTokenForDeveloperIdentityInput

func (GetOpenIdTokenForDeveloperIdentityInput) String

String returns the string representation

func (*GetOpenIdTokenForDeveloperIdentityInput) Validate

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

type GetOpenIdTokenForDeveloperIdentityOutput

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/GetOpenIdTokenForDeveloperIdentityResponse

func (GetOpenIdTokenForDeveloperIdentityOutput) String

String returns the string representation

type GetOpenIdTokenForDeveloperIdentityRequest

GetOpenIdTokenForDeveloperIdentityRequest is the request type for the GetOpenIdTokenForDeveloperIdentity API operation.

func (GetOpenIdTokenForDeveloperIdentityRequest) Send

Send marshals and sends the GetOpenIdTokenForDeveloperIdentity API request.

type GetOpenIdTokenForDeveloperIdentityResponse added in v0.9.0

type GetOpenIdTokenForDeveloperIdentityResponse struct {
	*GetOpenIdTokenForDeveloperIdentityOutput
	// contains filtered or unexported fields
}

GetOpenIdTokenForDeveloperIdentityResponse is the response type for the GetOpenIdTokenForDeveloperIdentity API operation.

func (*GetOpenIdTokenForDeveloperIdentityResponse) SDKResponseMetdata added in v0.9.0

func (r *GetOpenIdTokenForDeveloperIdentityResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetOpenIdTokenForDeveloperIdentity request.

type GetOpenIdTokenInput

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/GetOpenIdTokenInput

func (GetOpenIdTokenInput) String

func (s GetOpenIdTokenInput) String() string

String returns the string representation

func (*GetOpenIdTokenInput) Validate

func (s *GetOpenIdTokenInput) Validate() error

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

type GetOpenIdTokenOutput

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/GetOpenIdTokenResponse

func (GetOpenIdTokenOutput) String

func (s GetOpenIdTokenOutput) String() string

String returns the string representation

type GetOpenIdTokenRequest

type GetOpenIdTokenRequest struct {
	*aws.Request
	Input *GetOpenIdTokenInput
	Copy  func(*GetOpenIdTokenInput) GetOpenIdTokenRequest
}

GetOpenIdTokenRequest is the request type for the GetOpenIdToken API operation.

func (GetOpenIdTokenRequest) Send

Send marshals and sends the GetOpenIdToken API request.

type GetOpenIdTokenResponse added in v0.9.0

type GetOpenIdTokenResponse struct {
	*GetOpenIdTokenOutput
	// contains filtered or unexported fields
}

GetOpenIdTokenResponse is the response type for the GetOpenIdToken API operation.

func (*GetOpenIdTokenResponse) SDKResponseMetdata added in v0.9.0

func (r *GetOpenIdTokenResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetOpenIdToken request.

type IdentityDescription added in v0.9.0

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/IdentityDescription

func (IdentityDescription) String added in v0.9.0

func (s IdentityDescription) String() string

String returns the string representation

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/IdentityPoolShortDescription

func (IdentityPoolShortDescription) String

String returns the string representation

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/ListIdentitiesInput

func (ListIdentitiesInput) String

func (s ListIdentitiesInput) String() string

String returns the string representation

func (*ListIdentitiesInput) Validate

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/ListIdentitiesResponse

func (ListIdentitiesOutput) String

func (s ListIdentitiesOutput) String() string

String returns the string representation

type ListIdentitiesRequest

type ListIdentitiesRequest struct {
	*aws.Request
	Input *ListIdentitiesInput
	Copy  func(*ListIdentitiesInput) ListIdentitiesRequest
}

ListIdentitiesRequest is the request type for the ListIdentities API operation.

func (ListIdentitiesRequest) Send

Send marshals and sends the ListIdentities API request.

type ListIdentitiesResponse added in v0.9.0

type ListIdentitiesResponse struct {
	*ListIdentitiesOutput
	// contains filtered or unexported fields
}

ListIdentitiesResponse is the response type for the ListIdentities API operation.

func (*ListIdentitiesResponse) SDKResponseMetdata added in v0.9.0

func (r *ListIdentitiesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListIdentities request.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/ListIdentityPoolsInput

func (ListIdentityPoolsInput) String

func (s ListIdentityPoolsInput) String() string

String returns the string representation

func (*ListIdentityPoolsInput) Validate

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/ListIdentityPoolsResponse

func (ListIdentityPoolsOutput) String

func (s ListIdentityPoolsOutput) String() string

String returns the string representation

type ListIdentityPoolsRequest

type ListIdentityPoolsRequest struct {
	*aws.Request
	Input *ListIdentityPoolsInput
	Copy  func(*ListIdentityPoolsInput) ListIdentityPoolsRequest
}

ListIdentityPoolsRequest is the request type for the ListIdentityPools API operation.

func (ListIdentityPoolsRequest) Send

Send marshals and sends the ListIdentityPools API request.

type ListIdentityPoolsResponse added in v0.9.0

type ListIdentityPoolsResponse struct {
	*ListIdentityPoolsOutput
	// contains filtered or unexported fields
}

ListIdentityPoolsResponse is the response type for the ListIdentityPools API operation.

func (*ListIdentityPoolsResponse) SDKResponseMetdata added in v0.9.0

func (r *ListIdentityPoolsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListIdentityPools request.

type ListTagsForResourceInput added in v0.8.0

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/ListTagsForResourceInput

func (ListTagsForResourceInput) String added in v0.8.0

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate added in v0.8.0

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput added in v0.8.0

type ListTagsForResourceOutput struct {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/ListTagsForResourceResponse

func (ListTagsForResourceOutput) String added in v0.8.0

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListTagsForResourceRequest added in v0.8.0

type ListTagsForResourceRequest struct {
	*aws.Request
	Input *ListTagsForResourceInput
	Copy  func(*ListTagsForResourceInput) ListTagsForResourceRequest
}

ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.

func (ListTagsForResourceRequest) Send added in v0.8.0

Send marshals and sends the ListTagsForResource API request.

type ListTagsForResourceResponse added in v0.9.0

type ListTagsForResourceResponse struct {
	*ListTagsForResourceOutput
	// contains filtered or unexported fields
}

ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.

func (*ListTagsForResourceResponse) SDKResponseMetdata added in v0.9.0

func (r *ListTagsForResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTagsForResource request.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/LookupDeveloperIdentityInput

func (LookupDeveloperIdentityInput) String

String returns the string representation

func (*LookupDeveloperIdentityInput) Validate

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/LookupDeveloperIdentityResponse

func (LookupDeveloperIdentityOutput) String

String returns the string representation

type LookupDeveloperIdentityRequest

type LookupDeveloperIdentityRequest struct {
	*aws.Request
	Input *LookupDeveloperIdentityInput
	Copy  func(*LookupDeveloperIdentityInput) LookupDeveloperIdentityRequest
}

LookupDeveloperIdentityRequest is the request type for the LookupDeveloperIdentity API operation.

func (LookupDeveloperIdentityRequest) Send

Send marshals and sends the LookupDeveloperIdentity API request.

type LookupDeveloperIdentityResponse added in v0.9.0

type LookupDeveloperIdentityResponse struct {
	*LookupDeveloperIdentityOutput
	// contains filtered or unexported fields
}

LookupDeveloperIdentityResponse is the response type for the LookupDeveloperIdentity API operation.

func (*LookupDeveloperIdentityResponse) SDKResponseMetdata added in v0.9.0

func (r *LookupDeveloperIdentityResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the LookupDeveloperIdentity request.

type MappingRule

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 MappingRuleMatchType `type:"string" required:"true" enum:"true"`

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/MappingRule

func (MappingRule) String

func (s MappingRule) String() string

String returns the string representation

func (*MappingRule) Validate

func (s *MappingRule) Validate() error

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

type MappingRuleMatchType

type MappingRuleMatchType string
const (
	MappingRuleMatchTypeEquals     MappingRuleMatchType = "Equals"
	MappingRuleMatchTypeContains   MappingRuleMatchType = "Contains"
	MappingRuleMatchTypeStartsWith MappingRuleMatchType = "StartsWith"
	MappingRuleMatchTypeNotEqual   MappingRuleMatchType = "NotEqual"
)

Enum values for MappingRuleMatchType

func (MappingRuleMatchType) MarshalValue added in v0.3.0

func (enum MappingRuleMatchType) MarshalValue() (string, error)

func (MappingRuleMatchType) MarshalValueBuf added in v0.3.0

func (enum MappingRuleMatchType) MarshalValueBuf(b []byte) ([]byte, error)

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/MergeDeveloperIdentitiesInput

func (MergeDeveloperIdentitiesInput) String

String returns the string representation

func (*MergeDeveloperIdentitiesInput) Validate

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/MergeDeveloperIdentitiesResponse

func (MergeDeveloperIdentitiesOutput) String

String returns the string representation

type MergeDeveloperIdentitiesRequest

type MergeDeveloperIdentitiesRequest struct {
	*aws.Request
	Input *MergeDeveloperIdentitiesInput
	Copy  func(*MergeDeveloperIdentitiesInput) MergeDeveloperIdentitiesRequest
}

MergeDeveloperIdentitiesRequest is the request type for the MergeDeveloperIdentities API operation.

func (MergeDeveloperIdentitiesRequest) Send

Send marshals and sends the MergeDeveloperIdentities API request.

type MergeDeveloperIdentitiesResponse added in v0.9.0

type MergeDeveloperIdentitiesResponse struct {
	*MergeDeveloperIdentitiesOutput
	// contains filtered or unexported fields
}

MergeDeveloperIdentitiesResponse is the response type for the MergeDeveloperIdentities API operation.

func (*MergeDeveloperIdentitiesResponse) SDKResponseMetdata added in v0.9.0

func (r *MergeDeveloperIdentitiesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the MergeDeveloperIdentities request.

type RoleMapping

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 AmbiguousRoleResolutionType `type:"string" enum:"true"`

	// 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 RoleMappingType `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

A role mapping. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/RoleMapping

func (RoleMapping) String

func (s RoleMapping) String() string

String returns the string representation

func (*RoleMapping) Validate

func (s *RoleMapping) Validate() error

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

type RoleMappingType

type RoleMappingType string
const (
	RoleMappingTypeToken RoleMappingType = "Token"
	RoleMappingTypeRules RoleMappingType = "Rules"
)

Enum values for RoleMappingType

func (RoleMappingType) MarshalValue added in v0.3.0

func (enum RoleMappingType) MarshalValue() (string, error)

func (RoleMappingType) MarshalValueBuf added in v0.3.0

func (enum RoleMappingType) MarshalValueBuf(b []byte) ([]byte, error)

type RulesConfigurationType

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/RulesConfigurationType

func (RulesConfigurationType) String

func (s RulesConfigurationType) String() string

String returns the string representation

func (*RulesConfigurationType) Validate

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-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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/SetIdentityPoolRolesInput

func (SetIdentityPoolRolesInput) String

func (s SetIdentityPoolRolesInput) String() string

String returns the string representation

func (*SetIdentityPoolRolesInput) Validate

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/SetIdentityPoolRolesOutput

func (SetIdentityPoolRolesOutput) String

String returns the string representation

type SetIdentityPoolRolesRequest

type SetIdentityPoolRolesRequest struct {
	*aws.Request
	Input *SetIdentityPoolRolesInput
	Copy  func(*SetIdentityPoolRolesInput) SetIdentityPoolRolesRequest
}

SetIdentityPoolRolesRequest is the request type for the SetIdentityPoolRoles API operation.

func (SetIdentityPoolRolesRequest) Send

Send marshals and sends the SetIdentityPoolRoles API request.

type SetIdentityPoolRolesResponse added in v0.9.0

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

SetIdentityPoolRolesResponse is the response type for the SetIdentityPoolRoles API operation.

func (*SetIdentityPoolRolesResponse) SDKResponseMetdata added in v0.9.0

func (r *SetIdentityPoolRolesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the SetIdentityPoolRoles request.

type TagResourceInput added in v0.8.0

type TagResourceInput struct {

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/TagResourceInput

func (TagResourceInput) String added in v0.8.0

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate added in v0.8.0

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput added in v0.8.0

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/TagResourceResponse

func (TagResourceOutput) String added in v0.8.0

func (s TagResourceOutput) String() string

String returns the string representation

type TagResourceRequest added in v0.8.0

type TagResourceRequest struct {
	*aws.Request
	Input *TagResourceInput
	Copy  func(*TagResourceInput) TagResourceRequest
}

TagResourceRequest is the request type for the TagResource API operation.

func (TagResourceRequest) Send added in v0.8.0

Send marshals and sends the TagResource API request.

type TagResourceResponse added in v0.9.0

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

TagResourceResponse is the response type for the TagResource API operation.

func (*TagResourceResponse) SDKResponseMetdata added in v0.9.0

func (r *TagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the TagResource request.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/UnlinkDeveloperIdentityInput

func (UnlinkDeveloperIdentityInput) String

String returns the string representation

func (*UnlinkDeveloperIdentityInput) Validate

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/UnlinkDeveloperIdentityOutput

func (UnlinkDeveloperIdentityOutput) String

String returns the string representation

type UnlinkDeveloperIdentityRequest

type UnlinkDeveloperIdentityRequest struct {
	*aws.Request
	Input *UnlinkDeveloperIdentityInput
	Copy  func(*UnlinkDeveloperIdentityInput) UnlinkDeveloperIdentityRequest
}

UnlinkDeveloperIdentityRequest is the request type for the UnlinkDeveloperIdentity API operation.

func (UnlinkDeveloperIdentityRequest) Send

Send marshals and sends the UnlinkDeveloperIdentity API request.

type UnlinkDeveloperIdentityResponse added in v0.9.0

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

UnlinkDeveloperIdentityResponse is the response type for the UnlinkDeveloperIdentity API operation.

func (*UnlinkDeveloperIdentityResponse) SDKResponseMetdata added in v0.9.0

func (r *UnlinkDeveloperIdentityResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UnlinkDeveloperIdentity request.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/UnlinkIdentityInput

func (UnlinkIdentityInput) String

func (s UnlinkIdentityInput) String() string

String returns the string representation

func (*UnlinkIdentityInput) Validate

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/UnlinkIdentityOutput

func (UnlinkIdentityOutput) String

func (s UnlinkIdentityOutput) String() string

String returns the string representation

type UnlinkIdentityRequest

type UnlinkIdentityRequest struct {
	*aws.Request
	Input *UnlinkIdentityInput
	Copy  func(*UnlinkIdentityInput) UnlinkIdentityRequest
}

UnlinkIdentityRequest is the request type for the UnlinkIdentity API operation.

func (UnlinkIdentityRequest) Send

Send marshals and sends the UnlinkIdentity API request.

type UnlinkIdentityResponse added in v0.9.0

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

UnlinkIdentityResponse is the response type for the UnlinkIdentity API operation.

func (*UnlinkIdentityResponse) SDKResponseMetdata added in v0.9.0

func (r *UnlinkIdentityResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UnlinkIdentity request.

type UnprocessedIdentityId

type UnprocessedIdentityId struct {

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

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/UnprocessedIdentityId

func (UnprocessedIdentityId) String

func (s UnprocessedIdentityId) String() string

String returns the string representation

type UntagResourceInput added in v0.8.0

type UntagResourceInput 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"`

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/UntagResourceInput

func (UntagResourceInput) String added in v0.8.0

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate added in v0.8.0

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput added in v0.8.0

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/UntagResourceResponse

func (UntagResourceOutput) String added in v0.8.0

func (s UntagResourceOutput) String() string

String returns the string representation

type UntagResourceRequest added in v0.8.0

type UntagResourceRequest struct {
	*aws.Request
	Input *UntagResourceInput
	Copy  func(*UntagResourceInput) UntagResourceRequest
}

UntagResourceRequest is the request type for the UntagResource API operation.

func (UntagResourceRequest) Send added in v0.8.0

Send marshals and sends the UntagResource API request.

type UntagResourceResponse added in v0.9.0

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

UntagResourceResponse is the response type for the UntagResource API operation.

func (*UntagResourceResponse) SDKResponseMetdata added in v0.9.0

func (r *UntagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UntagResource request.

type UpdateIdentityPoolInput added in v0.9.0

type UpdateIdentityPoolInput struct {

	// 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 []CognitoIdentityProvider `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"`

	// A list of OpendID Connect provider ARNs.
	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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/IdentityPool

func (UpdateIdentityPoolInput) String added in v0.9.0

func (s UpdateIdentityPoolInput) String() string

String returns the string representation

func (*UpdateIdentityPoolInput) Validate added in v0.9.0

func (s *UpdateIdentityPoolInput) Validate() error

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

type UpdateIdentityPoolOutput

type UpdateIdentityPoolOutput struct {

	// 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 []CognitoIdentityProvider `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"`

	// A list of OpendID Connect provider ARNs.
	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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/IdentityPool

func (UpdateIdentityPoolOutput) String

func (s UpdateIdentityPoolOutput) String() string

String returns the string representation

type UpdateIdentityPoolRequest

type UpdateIdentityPoolRequest struct {
	*aws.Request
	Input *UpdateIdentityPoolInput
	Copy  func(*UpdateIdentityPoolInput) UpdateIdentityPoolRequest
}

UpdateIdentityPoolRequest is the request type for the UpdateIdentityPool API operation.

func (UpdateIdentityPoolRequest) Send

Send marshals and sends the UpdateIdentityPool API request.

type UpdateIdentityPoolResponse added in v0.9.0

type UpdateIdentityPoolResponse struct {
	*UpdateIdentityPoolOutput
	// contains filtered or unexported fields
}

UpdateIdentityPoolResponse is the response type for the UpdateIdentityPool API operation.

func (*UpdateIdentityPoolResponse) SDKResponseMetdata added in v0.9.0

func (r *UpdateIdentityPoolResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateIdentityPool request.

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