cognitoidentity

package
v0.1.0 Latest Latest
Warning

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

Go to latest
Published: Dec 21, 2017 License: Apache-2.0, Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

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

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

Using Amazon Cognito, you can enable authentication with one or more third-party identity providers (Facebook, Google, or Login with Amazon), 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.

To provide end-user credentials, first make an unsigned call to GetId. If the end user is authenticated with one of the supported identity providers, set the Logins map with the identity provider token. GetId returns a unique identifier for the user.

Next, make an unsigned call to GetCredentialsForIdentity. This call expects the same Logins map as the GetId call, as well as the IdentityID originally returned by GetId. Assuming your identity pool has been configured via the SetIdentityPoolRoles operation, GetCredentialsForIdentity will return AWS credentials for your use. If your pool has not been configured with SetIdentityPoolRoles, or if you want to follow legacy flow, make an unsigned call to GetOpenIdToken, which returns the OpenID token necessary to call STS and retrieve AWS credentials. This call expects the same Logins map as the GetId call, as well as the IdentityID originally returned by GetId. The token returned by GetOpenIdToken can be passed to the STS operation AssumeRoleWithWebIdentity (http://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithWebIdentity.html) to retrieve AWS credentials.

If you want to use Amazon Cognito in an Android, iOS, or Unity application, you will probably want to make API calls via the AWS Mobile SDK. To learn more, see the AWS Mobile SDK Developer Guide (http://docs.aws.amazon.com/mobile/index.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 Amazon Cognito Identity with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

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

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

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

Index

Constants

View Source
const (

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

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

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

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

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

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

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

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

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

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

	// ErrCodeTooManyRequestsException for service response error code
	// "TooManyRequestsException".
	//
	// Thrown when a request is throttled.
	ErrCodeTooManyRequestsException = "TooManyRequestsException"
)
View Source
const (
	ServiceName = "cognito-identity" // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName        // Service ID for Regions and Endpoints metadata.
)

Service information constants

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

type CognitoIdentity

type CognitoIdentity struct {
	*aws.Client
}

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

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

func New

func New(config aws.Config) *CognitoIdentity

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

Example:

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

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

func (*CognitoIdentity) CreateIdentityPoolRequest

func (c *CognitoIdentity) 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 the CreateIdentityPoolRequest method.
req := client.CreateIdentityPoolRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*CognitoIdentity) DeleteIdentitiesRequest

func (c *CognitoIdentity) 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 the DeleteIdentitiesRequest method.
req := client.DeleteIdentitiesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*CognitoIdentity) DeleteIdentityPoolRequest

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

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

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

You must use AWS Developer credentials to call this API.

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

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

func (*CognitoIdentity) DescribeIdentityPoolRequest

func (c *CognitoIdentity) 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 the DescribeIdentityPoolRequest method.
req := client.DescribeIdentityPoolRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*CognitoIdentity) DescribeIdentityRequest

func (c *CognitoIdentity) 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 the DescribeIdentityRequest method.
req := client.DescribeIdentityRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*CognitoIdentity) GetCredentialsForIdentityRequest

func (c *CognitoIdentity) 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 the GetCredentialsForIdentityRequest method.
req := client.GetCredentialsForIdentityRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*CognitoIdentity) GetIdRequest

func (c *CognitoIdentity) 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 the GetIdRequest method.
req := client.GetIdRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*CognitoIdentity) GetIdentityPoolRolesRequest

func (c *CognitoIdentity) 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 the GetIdentityPoolRolesRequest method.
req := client.GetIdentityPoolRolesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*CognitoIdentity) GetOpenIdTokenForDeveloperIdentityRequest

func (c *CognitoIdentity) 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 the GetOpenIdTokenForDeveloperIdentityRequest method.
req := client.GetOpenIdTokenForDeveloperIdentityRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*CognitoIdentity) GetOpenIdTokenRequest

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

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

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

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

func (*CognitoIdentity) ListIdentitiesRequest

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

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

Lists the identities in a pool.

You must use AWS Developer credentials to call this API.

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

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

func (*CognitoIdentity) ListIdentityPoolsRequest

func (c *CognitoIdentity) 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 the ListIdentityPoolsRequest method.
req := client.ListIdentityPoolsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*CognitoIdentity) LookupDeveloperIdentityRequest

func (c *CognitoIdentity) 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 DeveloperUserIdentifiers associated with an IdentityId for an existing identity. Either IdentityID or DeveloperUserIdentifier must not be null. If you supply only one of these values, the other value will be searched in the database and returned as a part of the response. If you supply both, DeveloperUserIdentifier will be matched against IdentityID. If the values are verified against the database, the response returns both values and is the same as the request. Otherwise a ResourceConflictException is thrown.

You must use AWS Developer credentials to call this API.

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

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

func (*CognitoIdentity) MergeDeveloperIdentitiesRequest

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

You must use AWS Developer credentials to call this API.

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

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

func (*CognitoIdentity) SetIdentityPoolRolesRequest

func (c *CognitoIdentity) 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 the SetIdentityPoolRolesRequest method.
req := client.SetIdentityPoolRolesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*CognitoIdentity) UnlinkDeveloperIdentityRequest

func (c *CognitoIdentity) 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 the UnlinkDeveloperIdentityRequest method.
req := client.UnlinkDeveloperIdentityRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*CognitoIdentity) UnlinkIdentityRequest

func (c *CognitoIdentity) 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 the UnlinkIdentityRequest method.
req := client.UnlinkIdentityRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*CognitoIdentity) UpdateIdentityPoolRequest

func (c *CognitoIdentity) UpdateIdentityPoolRequest(input *UpdateIdentityPoolOutput) UpdateIdentityPoolRequest

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

Updates a user pool.

You must use AWS Developer credentials to call this API.

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

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

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 Identity user pools and their client IDs.
	CognitoIdentityProviders []Provider `type:"list"`

	// The "domain" by which Cognito will refer to your users. This name acts as
	// a placeholder that allows your backend and the Cognito service to communicate
	// about the developer provider. For the DeveloperProviderName, you can use
	// letters as well as period (.), underscore (_), and dash (-).
	//
	// Once you have set a developer provider name, you cannot change it. Please
	// take care in setting this parameter.
	DeveloperProviderName *string `min:"1" type:"string"`

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

	// 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) GoString

func (s CreateIdentityPoolInput) GoString() string

GoString returns the string representation

func (*CreateIdentityPoolInput) SetAllowUnauthenticatedIdentities

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

SetAllowUnauthenticatedIdentities sets the AllowUnauthenticatedIdentities field's value.

func (*CreateIdentityPoolInput) SetCognitoIdentityProviders

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

SetCognitoIdentityProviders sets the CognitoIdentityProviders field's value.

func (*CreateIdentityPoolInput) SetDeveloperProviderName

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

SetDeveloperProviderName sets the DeveloperProviderName field's value.

func (*CreateIdentityPoolInput) SetIdentityPoolName

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

SetIdentityPoolName sets the IdentityPoolName field's value.

func (*CreateIdentityPoolInput) SetOpenIdConnectProviderARNs

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

SetOpenIdConnectProviderARNs sets the OpenIdConnectProviderARNs field's value.

func (*CreateIdentityPoolInput) SetSamlProviderARNs

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

SetSamlProviderARNs sets the SamlProviderARNs field's value.

func (*CreateIdentityPoolInput) SetSupportedLoginProviders

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

SetSupportedLoginProviders sets the SupportedLoginProviders field's value.

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 CreateIdentityPoolRequest

type CreateIdentityPoolRequest struct {
	*aws.Request
	Input *CreateIdentityPoolInput
}

CreateIdentityPoolRequest is a API request type for the CreateIdentityPool API operation.

func (CreateIdentityPoolRequest) Send

Send marshals and sends the CreateIdentityPool API 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" timestampFormat:"unix"`

	// 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) GoString

func (s Credentials) GoString() string

GoString returns the string representation

func (*Credentials) SetAccessKeyId

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

SetAccessKeyId sets the AccessKeyId field's value.

func (*Credentials) SetExpiration

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

SetExpiration sets the Expiration field's value.

func (*Credentials) SetSecretKey

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

SetSecretKey sets the SecretKey field's value.

func (*Credentials) SetSessionToken

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

SetSessionToken sets the SessionToken field's value.

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) GoString

func (s DeleteIdentitiesInput) GoString() string

GoString returns the string representation

func (*DeleteIdentitiesInput) SetIdentityIdsToDelete

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

SetIdentityIdsToDelete sets the IdentityIdsToDelete field's value.

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) GoString

func (s DeleteIdentitiesOutput) GoString() string

GoString returns the string representation

func (DeleteIdentitiesOutput) SDKResponseMetadata

func (s DeleteIdentitiesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*DeleteIdentitiesOutput) SetUnprocessedIdentityIds

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

SetUnprocessedIdentityIds sets the UnprocessedIdentityIds field's value.

func (DeleteIdentitiesOutput) String

func (s DeleteIdentitiesOutput) String() string

String returns the string representation

type DeleteIdentitiesRequest

type DeleteIdentitiesRequest struct {
	*aws.Request
	Input *DeleteIdentitiesInput
}

DeleteIdentitiesRequest is a API request type for the DeleteIdentities API operation.

func (DeleteIdentitiesRequest) Send

Send marshals and sends the DeleteIdentities API 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) GoString

func (s DeleteIdentityPoolInput) GoString() string

GoString returns the string representation

func (*DeleteIdentityPoolInput) SetIdentityPoolId

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

SetIdentityPoolId sets the IdentityPoolId field's value.

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) GoString

func (s DeleteIdentityPoolOutput) GoString() string

GoString returns the string representation

func (DeleteIdentityPoolOutput) SDKResponseMetadata

func (s DeleteIdentityPoolOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteIdentityPoolOutput) String

func (s DeleteIdentityPoolOutput) String() string

String returns the string representation

type DeleteIdentityPoolRequest

type DeleteIdentityPoolRequest struct {
	*aws.Request
	Input *DeleteIdentityPoolInput
}

DeleteIdentityPoolRequest is a API request type for the DeleteIdentityPool API operation.

func (DeleteIdentityPoolRequest) Send

Send marshals and sends the DeleteIdentityPool API 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) GoString

func (s DescribeIdentityInput) GoString() string

GoString returns the string representation

func (*DescribeIdentityInput) SetIdentityId

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

SetIdentityId sets the IdentityId field's value.

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" timestampFormat:"unix"`

	// 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" timestampFormat:"unix"`

	// A set of optional name-value pairs that map provider names to provider tokens.
	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) GoString

func (s DescribeIdentityOutput) GoString() string

GoString returns the string representation

func (DescribeIdentityOutput) SDKResponseMetadata

func (s DescribeIdentityOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*DescribeIdentityOutput) SetCreationDate

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

SetCreationDate sets the CreationDate field's value.

func (*DescribeIdentityOutput) SetIdentityId

SetIdentityId sets the IdentityId field's value.

func (*DescribeIdentityOutput) SetLastModifiedDate

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

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*DescribeIdentityOutput) SetLogins

SetLogins sets the Logins field's value.

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) GoString

func (s DescribeIdentityPoolInput) GoString() string

GoString returns the string representation

func (*DescribeIdentityPoolInput) SetIdentityPoolId

SetIdentityPoolId sets the IdentityPoolId field's value.

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 DescribeIdentityPoolRequest

type DescribeIdentityPoolRequest struct {
	*aws.Request
	Input *DescribeIdentityPoolInput
}

DescribeIdentityPoolRequest is a API request type for the DescribeIdentityPool API operation.

func (DescribeIdentityPoolRequest) Send

Send marshals and sends the DescribeIdentityPool API request.

type DescribeIdentityRequest

type DescribeIdentityRequest struct {
	*aws.Request
	Input *DescribeIdentityInput
}

DescribeIdentityRequest is a API request type for the DescribeIdentity API operation.

func (DescribeIdentityRequest) Send

Send marshals and sends the DescribeIdentity API request.

type ErrorCode

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

Enum values for ErrorCode

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.
	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) GoString

GoString returns the string representation

func (*GetCredentialsForIdentityInput) SetCustomRoleArn

SetCustomRoleArn sets the CustomRoleArn field's value.

func (*GetCredentialsForIdentityInput) SetIdentityId

SetIdentityId sets the IdentityId field's value.

func (*GetCredentialsForIdentityInput) SetLogins

SetLogins sets the Logins field's value.

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) GoString

GoString returns the string representation

func (GetCredentialsForIdentityOutput) SDKResponseMetadata

func (s GetCredentialsForIdentityOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*GetCredentialsForIdentityOutput) SetCredentials

SetCredentials sets the Credentials field's value.

func (*GetCredentialsForIdentityOutput) SetIdentityId

SetIdentityId sets the IdentityId field's value.

func (GetCredentialsForIdentityOutput) String

String returns the string representation

type GetCredentialsForIdentityRequest

type GetCredentialsForIdentityRequest struct {
	*aws.Request
	Input *GetCredentialsForIdentityInput
}

GetCredentialsForIdentityRequest is a API request type for the GetCredentialsForIdentity API operation.

func (GetCredentialsForIdentityRequest) Send

Send marshals and sends the GetCredentialsForIdentity API 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 Identity Provider: 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) GoString

func (s GetIdInput) GoString() string

GoString returns the string representation

func (*GetIdInput) SetAccountId

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

SetAccountId sets the AccountId field's value.

func (*GetIdInput) SetIdentityPoolId

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

SetIdentityPoolId sets the IdentityPoolId field's value.

func (*GetIdInput) SetLogins

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

SetLogins sets the Logins field's value.

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) GoString

func (s GetIdOutput) GoString() string

GoString returns the string representation

func (GetIdOutput) SDKResponseMetadata

func (s GetIdOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*GetIdOutput) SetIdentityId

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

SetIdentityId sets the IdentityId field's value.

func (GetIdOutput) String

func (s GetIdOutput) String() string

String returns the string representation

type GetIdRequest

type GetIdRequest struct {
	*aws.Request
	Input *GetIdInput
}

GetIdRequest is a API request type for the GetId API operation.

func (GetIdRequest) Send

func (r GetIdRequest) Send() (*GetIdOutput, error)

Send marshals and sends the GetId API 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) GoString

func (s GetIdentityPoolRolesInput) GoString() string

GoString returns the string representation

func (*GetIdentityPoolRolesInput) SetIdentityPoolId

SetIdentityPoolId sets the IdentityPoolId field's value.

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-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) GoString

func (s GetIdentityPoolRolesOutput) GoString() string

GoString returns the string representation

func (GetIdentityPoolRolesOutput) SDKResponseMetadata

func (s GetIdentityPoolRolesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*GetIdentityPoolRolesOutput) SetIdentityPoolId

SetIdentityPoolId sets the IdentityPoolId field's value.

func (*GetIdentityPoolRolesOutput) SetRoleMappings

SetRoleMappings sets the RoleMappings field's value.

func (*GetIdentityPoolRolesOutput) SetRoles

SetRoles sets the Roles field's value.

func (GetIdentityPoolRolesOutput) String

String returns the string representation

type GetIdentityPoolRolesRequest

type GetIdentityPoolRolesRequest struct {
	*aws.Request
	Input *GetIdentityPoolRolesInput
}

GetIdentityPoolRolesRequest is a API request type for the GetIdentityPoolRoles API operation.

func (GetIdentityPoolRolesRequest) Send

Send marshals and sends the GetIdentityPoolRoles API 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) GoString

GoString returns the string representation

func (*GetOpenIdTokenForDeveloperIdentityInput) SetIdentityId

SetIdentityId sets the IdentityId field's value.

func (*GetOpenIdTokenForDeveloperIdentityInput) SetIdentityPoolId

SetIdentityPoolId sets the IdentityPoolId field's value.

func (*GetOpenIdTokenForDeveloperIdentityInput) SetLogins

SetLogins sets the Logins field's value.

func (*GetOpenIdTokenForDeveloperIdentityInput) SetTokenDuration

SetTokenDuration sets the TokenDuration field's value.

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) GoString

GoString returns the string representation

func (GetOpenIdTokenForDeveloperIdentityOutput) SDKResponseMetadata

func (s GetOpenIdTokenForDeveloperIdentityOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*GetOpenIdTokenForDeveloperIdentityOutput) SetIdentityId

SetIdentityId sets the IdentityId field's value.

func (*GetOpenIdTokenForDeveloperIdentityOutput) SetToken

SetToken sets the Token field's value.

func (GetOpenIdTokenForDeveloperIdentityOutput) String

String returns the string representation

type GetOpenIdTokenForDeveloperIdentityRequest

type GetOpenIdTokenForDeveloperIdentityRequest struct {
	*aws.Request
	Input *GetOpenIdTokenForDeveloperIdentityInput
}

GetOpenIdTokenForDeveloperIdentityRequest is a API request type for the GetOpenIdTokenForDeveloperIdentity API operation.

func (GetOpenIdTokenForDeveloperIdentityRequest) Send

Send marshals and sends the GetOpenIdTokenForDeveloperIdentity API 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 Identity 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) GoString

func (s GetOpenIdTokenInput) GoString() string

GoString returns the string representation

func (*GetOpenIdTokenInput) SetIdentityId

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

SetIdentityId sets the IdentityId field's value.

func (*GetOpenIdTokenInput) SetLogins

SetLogins sets the Logins field's value.

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 15 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) GoString

func (s GetOpenIdTokenOutput) GoString() string

GoString returns the string representation

func (GetOpenIdTokenOutput) SDKResponseMetadata

func (s GetOpenIdTokenOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*GetOpenIdTokenOutput) SetIdentityId

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

SetIdentityId sets the IdentityId field's value.

func (*GetOpenIdTokenOutput) SetToken

SetToken sets the Token field's value.

func (GetOpenIdTokenOutput) String

func (s GetOpenIdTokenOutput) String() string

String returns the string representation

type GetOpenIdTokenRequest

type GetOpenIdTokenRequest struct {
	*aws.Request
	Input *GetOpenIdTokenInput
}

GetOpenIdTokenRequest is a API request type for the GetOpenIdToken API operation.

func (GetOpenIdTokenRequest) Send

Send marshals and sends the GetOpenIdToken API request.

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) GoString

func (s IdentityPoolShortDescription) GoString() string

GoString returns the string representation

func (*IdentityPoolShortDescription) SetIdentityPoolId

SetIdentityPoolId sets the IdentityPoolId field's value.

func (*IdentityPoolShortDescription) SetIdentityPoolName

SetIdentityPoolName sets the IdentityPoolName field's value.

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) GoString

func (s ListIdentitiesInput) GoString() string

GoString returns the string representation

func (*ListIdentitiesInput) SetHideDisabled

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

SetHideDisabled sets the HideDisabled field's value.

func (*ListIdentitiesInput) SetIdentityPoolId

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

SetIdentityPoolId sets the IdentityPoolId field's value.

func (*ListIdentitiesInput) SetMaxResults

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

SetMaxResults sets the MaxResults field's value.

func (*ListIdentitiesInput) SetNextToken

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

SetNextToken sets the NextToken field's value.

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 []DescribeIdentityOutput `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) GoString

func (s ListIdentitiesOutput) GoString() string

GoString returns the string representation

func (ListIdentitiesOutput) SDKResponseMetadata

func (s ListIdentitiesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*ListIdentitiesOutput) SetIdentities

SetIdentities sets the Identities field's value.

func (*ListIdentitiesOutput) SetIdentityPoolId

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

SetIdentityPoolId sets the IdentityPoolId field's value.

func (*ListIdentitiesOutput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (ListIdentitiesOutput) String

func (s ListIdentitiesOutput) String() string

String returns the string representation

type ListIdentitiesRequest

type ListIdentitiesRequest struct {
	*aws.Request
	Input *ListIdentitiesInput
}

ListIdentitiesRequest is a API request type for the ListIdentities API operation.

func (ListIdentitiesRequest) Send

Send marshals and sends the ListIdentities API 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) GoString

func (s ListIdentityPoolsInput) GoString() string

GoString returns the string representation

func (*ListIdentityPoolsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListIdentityPoolsInput) SetNextToken

SetNextToken sets the NextToken field's value.

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) GoString

func (s ListIdentityPoolsOutput) GoString() string

GoString returns the string representation

func (ListIdentityPoolsOutput) SDKResponseMetadata

func (s ListIdentityPoolsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*ListIdentityPoolsOutput) SetIdentityPools

SetIdentityPools sets the IdentityPools field's value.

func (*ListIdentityPoolsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListIdentityPoolsOutput) String

func (s ListIdentityPoolsOutput) String() string

String returns the string representation

type ListIdentityPoolsRequest

type ListIdentityPoolsRequest struct {
	*aws.Request
	Input *ListIdentityPoolsInput
}

ListIdentityPoolsRequest is a API request type for the ListIdentityPools API operation.

func (ListIdentityPoolsRequest) Send

Send marshals and sends the ListIdentityPools API 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) GoString

func (s LookupDeveloperIdentityInput) GoString() string

GoString returns the string representation

func (*LookupDeveloperIdentityInput) SetDeveloperUserIdentifier

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

SetDeveloperUserIdentifier sets the DeveloperUserIdentifier field's value.

func (*LookupDeveloperIdentityInput) SetIdentityId

SetIdentityId sets the IdentityId field's value.

func (*LookupDeveloperIdentityInput) SetIdentityPoolId

SetIdentityPoolId sets the IdentityPoolId field's value.

func (*LookupDeveloperIdentityInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*LookupDeveloperIdentityInput) SetNextToken

SetNextToken sets the NextToken field's value.

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) GoString

GoString returns the string representation

func (LookupDeveloperIdentityOutput) SDKResponseMetadata

func (s LookupDeveloperIdentityOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*LookupDeveloperIdentityOutput) SetDeveloperUserIdentifierList

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

SetDeveloperUserIdentifierList sets the DeveloperUserIdentifierList field's value.

func (*LookupDeveloperIdentityOutput) SetIdentityId

SetIdentityId sets the IdentityId field's value.

func (*LookupDeveloperIdentityOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (LookupDeveloperIdentityOutput) String

String returns the string representation

type LookupDeveloperIdentityRequest

type LookupDeveloperIdentityRequest struct {
	*aws.Request
	Input *LookupDeveloperIdentityInput
}

LookupDeveloperIdentityRequest is a API request type for the LookupDeveloperIdentity API operation.

func (LookupDeveloperIdentityRequest) Send

Send marshals and sends the LookupDeveloperIdentity API 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) GoString

func (s MappingRule) GoString() string

GoString returns the string representation

func (*MappingRule) SetClaim

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

SetClaim sets the Claim field's value.

func (*MappingRule) SetMatchType

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

SetMatchType sets the MatchType field's value.

func (*MappingRule) SetRoleARN

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

SetRoleARN sets the RoleARN field's value.

func (*MappingRule) SetValue

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

SetValue sets the Value field's value.

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

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) GoString

GoString returns the string representation

func (*MergeDeveloperIdentitiesInput) SetDestinationUserIdentifier

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

SetDestinationUserIdentifier sets the DestinationUserIdentifier field's value.

func (*MergeDeveloperIdentitiesInput) SetDeveloperProviderName

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

SetDeveloperProviderName sets the DeveloperProviderName field's value.

func (*MergeDeveloperIdentitiesInput) SetIdentityPoolId

SetIdentityPoolId sets the IdentityPoolId field's value.

func (*MergeDeveloperIdentitiesInput) SetSourceUserIdentifier

SetSourceUserIdentifier sets the SourceUserIdentifier field's value.

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) GoString

GoString returns the string representation

func (MergeDeveloperIdentitiesOutput) SDKResponseMetadata

func (s MergeDeveloperIdentitiesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*MergeDeveloperIdentitiesOutput) SetIdentityId

SetIdentityId sets the IdentityId field's value.

func (MergeDeveloperIdentitiesOutput) String

String returns the string representation

type MergeDeveloperIdentitiesRequest

type MergeDeveloperIdentitiesRequest struct {
	*aws.Request
	Input *MergeDeveloperIdentitiesInput
}

MergeDeveloperIdentitiesRequest is a API request type for the MergeDeveloperIdentities API operation.

func (MergeDeveloperIdentitiesRequest) Send

Send marshals and sends the MergeDeveloperIdentities API request.

type Provider

type Provider struct {

	// The client ID for the Amazon Cognito Identity User Pool.
	ClientId *string `min:"1" type:"string"`

	// The provider name for an Amazon Cognito Identity 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.
	ServerSideTokenCheck *bool `type:"boolean"`
	// contains filtered or unexported fields
}

A provider representing an Amazon Cognito Identity User Pool and its client ID. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/CognitoIdentityProvider

func (Provider) GoString

func (s Provider) GoString() string

GoString returns the string representation

func (*Provider) SetClientId

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

SetClientId sets the ClientId field's value.

func (*Provider) SetProviderName

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

SetProviderName sets the ProviderName field's value.

func (*Provider) SetServerSideTokenCheck

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

SetServerSideTokenCheck sets the ServerSideTokenCheck field's value.

func (Provider) String

func (s Provider) String() string

String returns the string representation

func (*Provider) Validate

func (s *Provider) Validate() error

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

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) GoString

func (s RoleMapping) GoString() string

GoString returns the string representation

func (*RoleMapping) SetAmbiguousRoleResolution

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

SetAmbiguousRoleResolution sets the AmbiguousRoleResolution field's value.

func (*RoleMapping) SetRulesConfiguration

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

SetRulesConfiguration sets the RulesConfiguration field's value.

func (*RoleMapping) SetType

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

SetType sets the Type field's value.

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

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) GoString

func (s RulesConfigurationType) GoString() string

GoString returns the string representation

func (*RulesConfigurationType) SetRules

SetRules sets the Rules field's value.

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) GoString

func (s SetIdentityPoolRolesInput) GoString() string

GoString returns the string representation

func (*SetIdentityPoolRolesInput) SetIdentityPoolId

SetIdentityPoolId sets the IdentityPoolId field's value.

func (*SetIdentityPoolRolesInput) SetRoleMappings

SetRoleMappings sets the RoleMappings field's value.

func (*SetIdentityPoolRolesInput) SetRoles

SetRoles sets the Roles field's value.

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) GoString

func (s SetIdentityPoolRolesOutput) GoString() string

GoString returns the string representation

func (SetIdentityPoolRolesOutput) SDKResponseMetadata

func (s SetIdentityPoolRolesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (SetIdentityPoolRolesOutput) String

String returns the string representation

type SetIdentityPoolRolesRequest

type SetIdentityPoolRolesRequest struct {
	*aws.Request
	Input *SetIdentityPoolRolesInput
}

SetIdentityPoolRolesRequest is a API request type for the SetIdentityPoolRoles API operation.

func (SetIdentityPoolRolesRequest) Send

Send marshals and sends the SetIdentityPoolRoles API 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) GoString

func (s UnlinkDeveloperIdentityInput) GoString() string

GoString returns the string representation

func (*UnlinkDeveloperIdentityInput) SetDeveloperProviderName

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

SetDeveloperProviderName sets the DeveloperProviderName field's value.

func (*UnlinkDeveloperIdentityInput) SetDeveloperUserIdentifier

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

SetDeveloperUserIdentifier sets the DeveloperUserIdentifier field's value.

func (*UnlinkDeveloperIdentityInput) SetIdentityId

SetIdentityId sets the IdentityId field's value.

func (*UnlinkDeveloperIdentityInput) SetIdentityPoolId

SetIdentityPoolId sets the IdentityPoolId field's value.

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) GoString

GoString returns the string representation

func (UnlinkDeveloperIdentityOutput) SDKResponseMetadata

func (s UnlinkDeveloperIdentityOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (UnlinkDeveloperIdentityOutput) String

String returns the string representation

type UnlinkDeveloperIdentityRequest

type UnlinkDeveloperIdentityRequest struct {
	*aws.Request
	Input *UnlinkDeveloperIdentityInput
}

UnlinkDeveloperIdentityRequest is a API request type for the UnlinkDeveloperIdentity API operation.

func (UnlinkDeveloperIdentityRequest) Send

Send marshals and sends the UnlinkDeveloperIdentity API 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) GoString

func (s UnlinkIdentityInput) GoString() string

GoString returns the string representation

func (*UnlinkIdentityInput) SetIdentityId

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

SetIdentityId sets the IdentityId field's value.

func (*UnlinkIdentityInput) SetLogins

SetLogins sets the Logins field's value.

func (*UnlinkIdentityInput) SetLoginsToRemove

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

SetLoginsToRemove sets the LoginsToRemove field's value.

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) GoString

func (s UnlinkIdentityOutput) GoString() string

GoString returns the string representation

func (UnlinkIdentityOutput) SDKResponseMetadata

func (s UnlinkIdentityOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (UnlinkIdentityOutput) String

func (s UnlinkIdentityOutput) String() string

String returns the string representation

type UnlinkIdentityRequest

type UnlinkIdentityRequest struct {
	*aws.Request
	Input *UnlinkIdentityInput
}

UnlinkIdentityRequest is a API request type for the UnlinkIdentity API operation.

func (UnlinkIdentityRequest) Send

Send marshals and sends the UnlinkIdentity API 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) GoString

func (s UnprocessedIdentityId) GoString() string

GoString returns the string representation

func (*UnprocessedIdentityId) SetErrorCode

SetErrorCode sets the ErrorCode field's value.

func (*UnprocessedIdentityId) SetIdentityId

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

SetIdentityId sets the IdentityId field's value.

func (UnprocessedIdentityId) String

func (s UnprocessedIdentityId) String() string

String returns the string representation

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 Identity User Pool and its client ID.
	CognitoIdentityProviders []Provider `type:"list"`

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

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

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

	// 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/UpdateIdentityPoolInput

func (UpdateIdentityPoolOutput) GoString

func (s UpdateIdentityPoolOutput) GoString() string

GoString returns the string representation

func (UpdateIdentityPoolOutput) SDKResponseMetadata

func (s UpdateIdentityPoolOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*UpdateIdentityPoolOutput) SetAllowUnauthenticatedIdentities

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

SetAllowUnauthenticatedIdentities sets the AllowUnauthenticatedIdentities field's value.

func (*UpdateIdentityPoolOutput) SetCognitoIdentityProviders

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

SetCognitoIdentityProviders sets the CognitoIdentityProviders field's value.

func (*UpdateIdentityPoolOutput) SetDeveloperProviderName

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

SetDeveloperProviderName sets the DeveloperProviderName field's value.

func (*UpdateIdentityPoolOutput) SetIdentityPoolId

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

SetIdentityPoolId sets the IdentityPoolId field's value.

func (*UpdateIdentityPoolOutput) SetIdentityPoolName

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

SetIdentityPoolName sets the IdentityPoolName field's value.

func (*UpdateIdentityPoolOutput) SetOpenIdConnectProviderARNs

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

SetOpenIdConnectProviderARNs sets the OpenIdConnectProviderARNs field's value.

func (*UpdateIdentityPoolOutput) SetSamlProviderARNs

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

SetSamlProviderARNs sets the SamlProviderARNs field's value.

func (*UpdateIdentityPoolOutput) SetSupportedLoginProviders

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

SetSupportedLoginProviders sets the SupportedLoginProviders field's value.

func (UpdateIdentityPoolOutput) String

func (s UpdateIdentityPoolOutput) String() string

String returns the string representation

func (*UpdateIdentityPoolOutput) Validate

func (s *UpdateIdentityPoolOutput) Validate() error

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

type UpdateIdentityPoolRequest

type UpdateIdentityPoolRequest struct {
	*aws.Request
	Input *UpdateIdentityPoolOutput
}

UpdateIdentityPoolRequest is a API request type for the UpdateIdentityPool API operation.

func (UpdateIdentityPoolRequest) Send

Send marshals and sends the UpdateIdentityPool API 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