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 contact Amazon Cognito Identity with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.
See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/
See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
See the Amazon Cognito Identity client CognitoIdentity for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/cognitoidentity/#New
Index ¶
- Constants
- type CognitoIdentity
- func (c *CognitoIdentity) CreateIdentityPool(input *CreateIdentityPoolInput) (*IdentityPool, error)
- func (c *CognitoIdentity) CreateIdentityPoolRequest(input *CreateIdentityPoolInput) (req *request.Request, output *IdentityPool)
- func (c *CognitoIdentity) CreateIdentityPoolWithContext(ctx aws.Context, input *CreateIdentityPoolInput, opts ...request.Option) (*IdentityPool, error)
- func (c *CognitoIdentity) DeleteIdentities(input *DeleteIdentitiesInput) (*DeleteIdentitiesOutput, error)
- func (c *CognitoIdentity) DeleteIdentitiesRequest(input *DeleteIdentitiesInput) (req *request.Request, output *DeleteIdentitiesOutput)
- func (c *CognitoIdentity) DeleteIdentitiesWithContext(ctx aws.Context, input *DeleteIdentitiesInput, opts ...request.Option) (*DeleteIdentitiesOutput, error)
- func (c *CognitoIdentity) DeleteIdentityPool(input *DeleteIdentityPoolInput) (*DeleteIdentityPoolOutput, error)
- func (c *CognitoIdentity) DeleteIdentityPoolRequest(input *DeleteIdentityPoolInput) (req *request.Request, output *DeleteIdentityPoolOutput)
- func (c *CognitoIdentity) DeleteIdentityPoolWithContext(ctx aws.Context, input *DeleteIdentityPoolInput, opts ...request.Option) (*DeleteIdentityPoolOutput, error)
- func (c *CognitoIdentity) DescribeIdentity(input *DescribeIdentityInput) (*IdentityDescription, error)
- func (c *CognitoIdentity) DescribeIdentityPool(input *DescribeIdentityPoolInput) (*IdentityPool, error)
- func (c *CognitoIdentity) DescribeIdentityPoolRequest(input *DescribeIdentityPoolInput) (req *request.Request, output *IdentityPool)
- func (c *CognitoIdentity) DescribeIdentityPoolWithContext(ctx aws.Context, input *DescribeIdentityPoolInput, opts ...request.Option) (*IdentityPool, error)
- func (c *CognitoIdentity) DescribeIdentityRequest(input *DescribeIdentityInput) (req *request.Request, output *IdentityDescription)
- func (c *CognitoIdentity) DescribeIdentityWithContext(ctx aws.Context, input *DescribeIdentityInput, opts ...request.Option) (*IdentityDescription, error)
- func (c *CognitoIdentity) GetCredentialsForIdentity(input *GetCredentialsForIdentityInput) (*GetCredentialsForIdentityOutput, error)
- func (c *CognitoIdentity) GetCredentialsForIdentityRequest(input *GetCredentialsForIdentityInput) (req *request.Request, output *GetCredentialsForIdentityOutput)
- func (c *CognitoIdentity) GetCredentialsForIdentityWithContext(ctx aws.Context, input *GetCredentialsForIdentityInput, opts ...request.Option) (*GetCredentialsForIdentityOutput, error)
- func (c *CognitoIdentity) GetId(input *GetIdInput) (*GetIdOutput, error)
- func (c *CognitoIdentity) GetIdRequest(input *GetIdInput) (req *request.Request, output *GetIdOutput)
- func (c *CognitoIdentity) GetIdWithContext(ctx aws.Context, input *GetIdInput, opts ...request.Option) (*GetIdOutput, error)
- func (c *CognitoIdentity) GetIdentityPoolRoles(input *GetIdentityPoolRolesInput) (*GetIdentityPoolRolesOutput, error)
- func (c *CognitoIdentity) GetIdentityPoolRolesRequest(input *GetIdentityPoolRolesInput) (req *request.Request, output *GetIdentityPoolRolesOutput)
- func (c *CognitoIdentity) GetIdentityPoolRolesWithContext(ctx aws.Context, input *GetIdentityPoolRolesInput, opts ...request.Option) (*GetIdentityPoolRolesOutput, error)
- func (c *CognitoIdentity) GetOpenIdToken(input *GetOpenIdTokenInput) (*GetOpenIdTokenOutput, error)
- func (c *CognitoIdentity) GetOpenIdTokenForDeveloperIdentity(input *GetOpenIdTokenForDeveloperIdentityInput) (*GetOpenIdTokenForDeveloperIdentityOutput, error)
- func (c *CognitoIdentity) GetOpenIdTokenForDeveloperIdentityRequest(input *GetOpenIdTokenForDeveloperIdentityInput) (req *request.Request, output *GetOpenIdTokenForDeveloperIdentityOutput)
- func (c *CognitoIdentity) GetOpenIdTokenForDeveloperIdentityWithContext(ctx aws.Context, input *GetOpenIdTokenForDeveloperIdentityInput, ...) (*GetOpenIdTokenForDeveloperIdentityOutput, error)
- func (c *CognitoIdentity) GetOpenIdTokenRequest(input *GetOpenIdTokenInput) (req *request.Request, output *GetOpenIdTokenOutput)
- func (c *CognitoIdentity) GetOpenIdTokenWithContext(ctx aws.Context, input *GetOpenIdTokenInput, opts ...request.Option) (*GetOpenIdTokenOutput, error)
- func (c *CognitoIdentity) ListIdentities(input *ListIdentitiesInput) (*ListIdentitiesOutput, error)
- func (c *CognitoIdentity) ListIdentitiesRequest(input *ListIdentitiesInput) (req *request.Request, output *ListIdentitiesOutput)
- func (c *CognitoIdentity) ListIdentitiesWithContext(ctx aws.Context, input *ListIdentitiesInput, opts ...request.Option) (*ListIdentitiesOutput, error)
- func (c *CognitoIdentity) ListIdentityPools(input *ListIdentityPoolsInput) (*ListIdentityPoolsOutput, error)
- func (c *CognitoIdentity) ListIdentityPoolsRequest(input *ListIdentityPoolsInput) (req *request.Request, output *ListIdentityPoolsOutput)
- func (c *CognitoIdentity) ListIdentityPoolsWithContext(ctx aws.Context, input *ListIdentityPoolsInput, opts ...request.Option) (*ListIdentityPoolsOutput, error)
- func (c *CognitoIdentity) LookupDeveloperIdentity(input *LookupDeveloperIdentityInput) (*LookupDeveloperIdentityOutput, error)
- func (c *CognitoIdentity) LookupDeveloperIdentityRequest(input *LookupDeveloperIdentityInput) (req *request.Request, output *LookupDeveloperIdentityOutput)
- func (c *CognitoIdentity) LookupDeveloperIdentityWithContext(ctx aws.Context, input *LookupDeveloperIdentityInput, opts ...request.Option) (*LookupDeveloperIdentityOutput, error)
- func (c *CognitoIdentity) MergeDeveloperIdentities(input *MergeDeveloperIdentitiesInput) (*MergeDeveloperIdentitiesOutput, error)
- func (c *CognitoIdentity) MergeDeveloperIdentitiesRequest(input *MergeDeveloperIdentitiesInput) (req *request.Request, output *MergeDeveloperIdentitiesOutput)
- func (c *CognitoIdentity) MergeDeveloperIdentitiesWithContext(ctx aws.Context, input *MergeDeveloperIdentitiesInput, opts ...request.Option) (*MergeDeveloperIdentitiesOutput, error)
- func (c *CognitoIdentity) SetIdentityPoolRoles(input *SetIdentityPoolRolesInput) (*SetIdentityPoolRolesOutput, error)
- func (c *CognitoIdentity) SetIdentityPoolRolesRequest(input *SetIdentityPoolRolesInput) (req *request.Request, output *SetIdentityPoolRolesOutput)
- func (c *CognitoIdentity) SetIdentityPoolRolesWithContext(ctx aws.Context, input *SetIdentityPoolRolesInput, opts ...request.Option) (*SetIdentityPoolRolesOutput, error)
- func (c *CognitoIdentity) UnlinkDeveloperIdentity(input *UnlinkDeveloperIdentityInput) (*UnlinkDeveloperIdentityOutput, error)
- func (c *CognitoIdentity) UnlinkDeveloperIdentityRequest(input *UnlinkDeveloperIdentityInput) (req *request.Request, output *UnlinkDeveloperIdentityOutput)
- func (c *CognitoIdentity) UnlinkDeveloperIdentityWithContext(ctx aws.Context, input *UnlinkDeveloperIdentityInput, opts ...request.Option) (*UnlinkDeveloperIdentityOutput, error)
- func (c *CognitoIdentity) UnlinkIdentity(input *UnlinkIdentityInput) (*UnlinkIdentityOutput, error)
- func (c *CognitoIdentity) UnlinkIdentityRequest(input *UnlinkIdentityInput) (req *request.Request, output *UnlinkIdentityOutput)
- func (c *CognitoIdentity) UnlinkIdentityWithContext(ctx aws.Context, input *UnlinkIdentityInput, opts ...request.Option) (*UnlinkIdentityOutput, error)
- func (c *CognitoIdentity) UpdateIdentityPool(input *IdentityPool) (*IdentityPool, error)
- func (c *CognitoIdentity) UpdateIdentityPoolRequest(input *IdentityPool) (req *request.Request, output *IdentityPool)
- func (c *CognitoIdentity) UpdateIdentityPoolWithContext(ctx aws.Context, input *IdentityPool, opts ...request.Option) (*IdentityPool, error)
- type CreateIdentityPoolInput
- func (s CreateIdentityPoolInput) GoString() string
- func (s *CreateIdentityPoolInput) SetAllowUnauthenticatedIdentities(v bool) *CreateIdentityPoolInput
- func (s *CreateIdentityPoolInput) SetCognitoIdentityProviders(v []*Provider) *CreateIdentityPoolInput
- func (s *CreateIdentityPoolInput) SetDeveloperProviderName(v string) *CreateIdentityPoolInput
- func (s *CreateIdentityPoolInput) SetIdentityPoolName(v string) *CreateIdentityPoolInput
- func (s *CreateIdentityPoolInput) SetOpenIdConnectProviderARNs(v []*string) *CreateIdentityPoolInput
- func (s *CreateIdentityPoolInput) SetSamlProviderARNs(v []*string) *CreateIdentityPoolInput
- func (s *CreateIdentityPoolInput) SetSupportedLoginProviders(v map[string]*string) *CreateIdentityPoolInput
- func (s CreateIdentityPoolInput) String() string
- func (s *CreateIdentityPoolInput) Validate() error
- type Credentials
- func (s Credentials) GoString() string
- func (s *Credentials) SetAccessKeyId(v string) *Credentials
- func (s *Credentials) SetExpiration(v time.Time) *Credentials
- func (s *Credentials) SetSecretKey(v string) *Credentials
- func (s *Credentials) SetSessionToken(v string) *Credentials
- func (s Credentials) String() string
- type DeleteIdentitiesInput
- type DeleteIdentitiesOutput
- type DeleteIdentityPoolInput
- type DeleteIdentityPoolOutput
- type DescribeIdentityInput
- type DescribeIdentityPoolInput
- type GetCredentialsForIdentityInput
- func (s GetCredentialsForIdentityInput) GoString() string
- func (s *GetCredentialsForIdentityInput) SetCustomRoleArn(v string) *GetCredentialsForIdentityInput
- func (s *GetCredentialsForIdentityInput) SetIdentityId(v string) *GetCredentialsForIdentityInput
- func (s *GetCredentialsForIdentityInput) SetLogins(v map[string]*string) *GetCredentialsForIdentityInput
- func (s GetCredentialsForIdentityInput) String() string
- func (s *GetCredentialsForIdentityInput) Validate() error
- type GetCredentialsForIdentityOutput
- func (s GetCredentialsForIdentityOutput) GoString() string
- func (s *GetCredentialsForIdentityOutput) SetCredentials(v *Credentials) *GetCredentialsForIdentityOutput
- func (s *GetCredentialsForIdentityOutput) SetIdentityId(v string) *GetCredentialsForIdentityOutput
- func (s GetCredentialsForIdentityOutput) String() string
- type GetIdInput
- type GetIdOutput
- type GetIdentityPoolRolesInput
- type GetIdentityPoolRolesOutput
- func (s GetIdentityPoolRolesOutput) GoString() string
- func (s *GetIdentityPoolRolesOutput) SetIdentityPoolId(v string) *GetIdentityPoolRolesOutput
- func (s *GetIdentityPoolRolesOutput) SetRoleMappings(v map[string]*RoleMapping) *GetIdentityPoolRolesOutput
- func (s *GetIdentityPoolRolesOutput) SetRoles(v map[string]*string) *GetIdentityPoolRolesOutput
- func (s GetIdentityPoolRolesOutput) String() string
- type GetOpenIdTokenForDeveloperIdentityInput
- func (s GetOpenIdTokenForDeveloperIdentityInput) GoString() string
- func (s *GetOpenIdTokenForDeveloperIdentityInput) SetIdentityId(v string) *GetOpenIdTokenForDeveloperIdentityInput
- func (s *GetOpenIdTokenForDeveloperIdentityInput) SetIdentityPoolId(v string) *GetOpenIdTokenForDeveloperIdentityInput
- func (s *GetOpenIdTokenForDeveloperIdentityInput) SetLogins(v map[string]*string) *GetOpenIdTokenForDeveloperIdentityInput
- func (s *GetOpenIdTokenForDeveloperIdentityInput) SetTokenDuration(v int64) *GetOpenIdTokenForDeveloperIdentityInput
- func (s GetOpenIdTokenForDeveloperIdentityInput) String() string
- func (s *GetOpenIdTokenForDeveloperIdentityInput) Validate() error
- type GetOpenIdTokenForDeveloperIdentityOutput
- func (s GetOpenIdTokenForDeveloperIdentityOutput) GoString() string
- func (s *GetOpenIdTokenForDeveloperIdentityOutput) SetIdentityId(v string) *GetOpenIdTokenForDeveloperIdentityOutput
- func (s *GetOpenIdTokenForDeveloperIdentityOutput) SetToken(v string) *GetOpenIdTokenForDeveloperIdentityOutput
- func (s GetOpenIdTokenForDeveloperIdentityOutput) String() string
- type GetOpenIdTokenInput
- type GetOpenIdTokenOutput
- type IdentityDescription
- func (s IdentityDescription) GoString() string
- func (s *IdentityDescription) SetCreationDate(v time.Time) *IdentityDescription
- func (s *IdentityDescription) SetIdentityId(v string) *IdentityDescription
- func (s *IdentityDescription) SetLastModifiedDate(v time.Time) *IdentityDescription
- func (s *IdentityDescription) SetLogins(v []*string) *IdentityDescription
- func (s IdentityDescription) String() string
- type IdentityPool
- func (s IdentityPool) GoString() string
- func (s *IdentityPool) SetAllowUnauthenticatedIdentities(v bool) *IdentityPool
- func (s *IdentityPool) SetCognitoIdentityProviders(v []*Provider) *IdentityPool
- func (s *IdentityPool) SetDeveloperProviderName(v string) *IdentityPool
- func (s *IdentityPool) SetIdentityPoolId(v string) *IdentityPool
- func (s *IdentityPool) SetIdentityPoolName(v string) *IdentityPool
- func (s *IdentityPool) SetOpenIdConnectProviderARNs(v []*string) *IdentityPool
- func (s *IdentityPool) SetSamlProviderARNs(v []*string) *IdentityPool
- func (s *IdentityPool) SetSupportedLoginProviders(v map[string]*string) *IdentityPool
- func (s IdentityPool) String() string
- func (s *IdentityPool) Validate() error
- type IdentityPoolShortDescription
- func (s IdentityPoolShortDescription) GoString() string
- func (s *IdentityPoolShortDescription) SetIdentityPoolId(v string) *IdentityPoolShortDescription
- func (s *IdentityPoolShortDescription) SetIdentityPoolName(v string) *IdentityPoolShortDescription
- func (s IdentityPoolShortDescription) String() string
- type ListIdentitiesInput
- func (s ListIdentitiesInput) GoString() string
- func (s *ListIdentitiesInput) SetHideDisabled(v bool) *ListIdentitiesInput
- func (s *ListIdentitiesInput) SetIdentityPoolId(v string) *ListIdentitiesInput
- func (s *ListIdentitiesInput) SetMaxResults(v int64) *ListIdentitiesInput
- func (s *ListIdentitiesInput) SetNextToken(v string) *ListIdentitiesInput
- func (s ListIdentitiesInput) String() string
- func (s *ListIdentitiesInput) Validate() error
- type ListIdentitiesOutput
- func (s ListIdentitiesOutput) GoString() string
- func (s *ListIdentitiesOutput) SetIdentities(v []*IdentityDescription) *ListIdentitiesOutput
- func (s *ListIdentitiesOutput) SetIdentityPoolId(v string) *ListIdentitiesOutput
- func (s *ListIdentitiesOutput) SetNextToken(v string) *ListIdentitiesOutput
- func (s ListIdentitiesOutput) String() string
- type ListIdentityPoolsInput
- func (s ListIdentityPoolsInput) GoString() string
- func (s *ListIdentityPoolsInput) SetMaxResults(v int64) *ListIdentityPoolsInput
- func (s *ListIdentityPoolsInput) SetNextToken(v string) *ListIdentityPoolsInput
- func (s ListIdentityPoolsInput) String() string
- func (s *ListIdentityPoolsInput) Validate() error
- type ListIdentityPoolsOutput
- type LookupDeveloperIdentityInput
- func (s LookupDeveloperIdentityInput) GoString() string
- func (s *LookupDeveloperIdentityInput) SetDeveloperUserIdentifier(v string) *LookupDeveloperIdentityInput
- func (s *LookupDeveloperIdentityInput) SetIdentityId(v string) *LookupDeveloperIdentityInput
- func (s *LookupDeveloperIdentityInput) SetIdentityPoolId(v string) *LookupDeveloperIdentityInput
- func (s *LookupDeveloperIdentityInput) SetMaxResults(v int64) *LookupDeveloperIdentityInput
- func (s *LookupDeveloperIdentityInput) SetNextToken(v string) *LookupDeveloperIdentityInput
- func (s LookupDeveloperIdentityInput) String() string
- func (s *LookupDeveloperIdentityInput) Validate() error
- type LookupDeveloperIdentityOutput
- func (s LookupDeveloperIdentityOutput) GoString() string
- func (s *LookupDeveloperIdentityOutput) SetDeveloperUserIdentifierList(v []*string) *LookupDeveloperIdentityOutput
- func (s *LookupDeveloperIdentityOutput) SetIdentityId(v string) *LookupDeveloperIdentityOutput
- func (s *LookupDeveloperIdentityOutput) SetNextToken(v string) *LookupDeveloperIdentityOutput
- func (s LookupDeveloperIdentityOutput) String() string
- type MappingRule
- func (s MappingRule) GoString() string
- func (s *MappingRule) SetClaim(v string) *MappingRule
- func (s *MappingRule) SetMatchType(v string) *MappingRule
- func (s *MappingRule) SetRoleARN(v string) *MappingRule
- func (s *MappingRule) SetValue(v string) *MappingRule
- func (s MappingRule) String() string
- func (s *MappingRule) Validate() error
- type MergeDeveloperIdentitiesInput
- func (s MergeDeveloperIdentitiesInput) GoString() string
- func (s *MergeDeveloperIdentitiesInput) SetDestinationUserIdentifier(v string) *MergeDeveloperIdentitiesInput
- func (s *MergeDeveloperIdentitiesInput) SetDeveloperProviderName(v string) *MergeDeveloperIdentitiesInput
- func (s *MergeDeveloperIdentitiesInput) SetIdentityPoolId(v string) *MergeDeveloperIdentitiesInput
- func (s *MergeDeveloperIdentitiesInput) SetSourceUserIdentifier(v string) *MergeDeveloperIdentitiesInput
- func (s MergeDeveloperIdentitiesInput) String() string
- func (s *MergeDeveloperIdentitiesInput) Validate() error
- type MergeDeveloperIdentitiesOutput
- type Provider
- type RoleMapping
- func (s RoleMapping) GoString() string
- func (s *RoleMapping) SetAmbiguousRoleResolution(v string) *RoleMapping
- func (s *RoleMapping) SetRulesConfiguration(v *RulesConfigurationType) *RoleMapping
- func (s *RoleMapping) SetType(v string) *RoleMapping
- func (s RoleMapping) String() string
- func (s *RoleMapping) Validate() error
- type RulesConfigurationType
- type SetIdentityPoolRolesInput
- func (s SetIdentityPoolRolesInput) GoString() string
- func (s *SetIdentityPoolRolesInput) SetIdentityPoolId(v string) *SetIdentityPoolRolesInput
- func (s *SetIdentityPoolRolesInput) SetRoleMappings(v map[string]*RoleMapping) *SetIdentityPoolRolesInput
- func (s *SetIdentityPoolRolesInput) SetRoles(v map[string]*string) *SetIdentityPoolRolesInput
- func (s SetIdentityPoolRolesInput) String() string
- func (s *SetIdentityPoolRolesInput) Validate() error
- type SetIdentityPoolRolesOutput
- type UnlinkDeveloperIdentityInput
- func (s UnlinkDeveloperIdentityInput) GoString() string
- func (s *UnlinkDeveloperIdentityInput) SetDeveloperProviderName(v string) *UnlinkDeveloperIdentityInput
- func (s *UnlinkDeveloperIdentityInput) SetDeveloperUserIdentifier(v string) *UnlinkDeveloperIdentityInput
- func (s *UnlinkDeveloperIdentityInput) SetIdentityId(v string) *UnlinkDeveloperIdentityInput
- func (s *UnlinkDeveloperIdentityInput) SetIdentityPoolId(v string) *UnlinkDeveloperIdentityInput
- func (s UnlinkDeveloperIdentityInput) String() string
- func (s *UnlinkDeveloperIdentityInput) Validate() error
- type UnlinkDeveloperIdentityOutput
- type UnlinkIdentityInput
- func (s UnlinkIdentityInput) GoString() string
- func (s *UnlinkIdentityInput) SetIdentityId(v string) *UnlinkIdentityInput
- func (s *UnlinkIdentityInput) SetLogins(v map[string]*string) *UnlinkIdentityInput
- func (s *UnlinkIdentityInput) SetLoginsToRemove(v []*string) *UnlinkIdentityInput
- func (s UnlinkIdentityInput) String() string
- func (s *UnlinkIdentityInput) Validate() error
- type UnlinkIdentityOutput
- type UnprocessedIdentityId
Constants ¶
const ( // AmbiguousRoleResolutionTypeAuthenticatedRole is a AmbiguousRoleResolutionType enum value AmbiguousRoleResolutionTypeAuthenticatedRole = "AuthenticatedRole" // AmbiguousRoleResolutionTypeDeny is a AmbiguousRoleResolutionType enum value AmbiguousRoleResolutionTypeDeny = "Deny" )
const ( // ErrorCodeAccessDenied is a ErrorCode enum value ErrorCodeAccessDenied = "AccessDenied" // ErrorCodeInternalServerError is a ErrorCode enum value ErrorCodeInternalServerError = "InternalServerError" )
const ( // MappingRuleMatchTypeEquals is a MappingRuleMatchType enum value MappingRuleMatchTypeEquals = "Equals" // MappingRuleMatchTypeContains is a MappingRuleMatchType enum value MappingRuleMatchTypeContains = "Contains" // MappingRuleMatchTypeStartsWith is a MappingRuleMatchType enum value MappingRuleMatchTypeStartsWith = "StartsWith" // MappingRuleMatchTypeNotEqual is a MappingRuleMatchType enum value MappingRuleMatchTypeNotEqual = "NotEqual" )
const ( // RoleMappingTypeToken is a RoleMappingType enum value RoleMappingTypeToken = "Token" // RoleMappingTypeRules is a RoleMappingType enum value RoleMappingTypeRules = "Rules" )
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" )
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 CognitoIdentity ¶
CognitoIdentity provides the API operation methods for making requests to Amazon Cognito Identity. See this package's package overview docs for details on the service.
CognitoIdentity methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New ¶
func New(p client.ConfigProvider, cfgs ...*aws.Config) *CognitoIdentity
New creates a new instance of the CognitoIdentity client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.
Example:
// Create a CognitoIdentity client from just a session. svc := cognitoidentity.New(mySession) // Create a CognitoIdentity client with additional configuration svc := cognitoidentity.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (*CognitoIdentity) CreateIdentityPool ¶
func (c *CognitoIdentity) CreateIdentityPool(input *CreateIdentityPoolInput) (*IdentityPool, error)
CreateIdentityPool API operation for Amazon Cognito Identity.
Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account. The limit on identity pools is 60 per account. The keys for SupportedLoginProviders are as follows:
Facebook: graph.facebook.com
Google: accounts.google.com
Amazon: www.amazon.com
Twitter: api.twitter.com
Digits: www.digits.com
You must use AWS Developer credentials to call this API.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Cognito Identity's API operation CreateIdentityPool for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterException "InvalidParameterException" Thrown for missing or bad input parameter(s).
ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.
ErrCodeResourceConflictException "ResourceConflictException" Thrown when a user tries to use a login which is already linked to another account.
ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown when a request is throttled.
ErrCodeInternalErrorException "InternalErrorException" Thrown when the service encounters an error during processing the request.
ErrCodeLimitExceededException "LimitExceededException" Thrown when the total number of user pools has exceeded a preset limit.
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/CreateIdentityPool
func (*CognitoIdentity) CreateIdentityPoolRequest ¶
func (c *CognitoIdentity) CreateIdentityPoolRequest(input *CreateIdentityPoolInput) (req *request.Request, output *IdentityPool)
CreateIdentityPoolRequest generates a "aws/request.Request" representing the client's request for the CreateIdentityPool operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateIdentityPool for more information on using the CreateIdentityPool API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateIdentityPoolRequest method. req, resp := client.CreateIdentityPoolRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/CreateIdentityPool
func (*CognitoIdentity) CreateIdentityPoolWithContext ¶ added in v1.9.0
func (c *CognitoIdentity) CreateIdentityPoolWithContext(ctx aws.Context, input *CreateIdentityPoolInput, opts ...request.Option) (*IdentityPool, error)
CreateIdentityPoolWithContext is the same as CreateIdentityPool with the addition of the ability to pass a context and additional request options.
See CreateIdentityPool for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CognitoIdentity) DeleteIdentities ¶
func (c *CognitoIdentity) DeleteIdentities(input *DeleteIdentitiesInput) (*DeleteIdentitiesOutput, error)
DeleteIdentities API operation for Amazon Cognito Identity.
Deletes identities from an identity pool. You can specify a list of 1-60 identities that you want to delete.
You must use AWS Developer credentials to call this API.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Cognito Identity's API operation DeleteIdentities for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterException "InvalidParameterException" Thrown for missing or bad input parameter(s).
ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown when a request is throttled.
ErrCodeInternalErrorException "InternalErrorException" Thrown when the service encounters an error during processing the request.
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/DeleteIdentities
func (*CognitoIdentity) DeleteIdentitiesRequest ¶
func (c *CognitoIdentity) DeleteIdentitiesRequest(input *DeleteIdentitiesInput) (req *request.Request, output *DeleteIdentitiesOutput)
DeleteIdentitiesRequest generates a "aws/request.Request" representing the client's request for the DeleteIdentities operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteIdentities for more information on using the DeleteIdentities API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteIdentitiesRequest method. req, resp := client.DeleteIdentitiesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/DeleteIdentities
func (*CognitoIdentity) DeleteIdentitiesWithContext ¶ added in v1.9.0
func (c *CognitoIdentity) DeleteIdentitiesWithContext(ctx aws.Context, input *DeleteIdentitiesInput, opts ...request.Option) (*DeleteIdentitiesOutput, error)
DeleteIdentitiesWithContext is the same as DeleteIdentities with the addition of the ability to pass a context and additional request options.
See DeleteIdentities for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CognitoIdentity) DeleteIdentityPool ¶
func (c *CognitoIdentity) DeleteIdentityPool(input *DeleteIdentityPoolInput) (*DeleteIdentityPoolOutput, error)
DeleteIdentityPool API operation for Amazon Cognito Identity.
Deletes a user pool. Once a pool is deleted, users will not be able to authenticate with the pool.
You must use AWS Developer credentials to call this API.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Cognito Identity's API operation DeleteIdentityPool for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterException "InvalidParameterException" Thrown for missing or bad input parameter(s).
ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown when the requested resource (for example, a dataset or record) does not exist.
ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.
ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown when a request is throttled.
ErrCodeInternalErrorException "InternalErrorException" Thrown when the service encounters an error during processing the request.
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/DeleteIdentityPool
func (*CognitoIdentity) DeleteIdentityPoolRequest ¶
func (c *CognitoIdentity) DeleteIdentityPoolRequest(input *DeleteIdentityPoolInput) (req *request.Request, output *DeleteIdentityPoolOutput)
DeleteIdentityPoolRequest generates a "aws/request.Request" representing the client's request for the DeleteIdentityPool operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteIdentityPool for more information on using the DeleteIdentityPool API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteIdentityPoolRequest method. req, resp := client.DeleteIdentityPoolRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/DeleteIdentityPool
func (*CognitoIdentity) DeleteIdentityPoolWithContext ¶ added in v1.9.0
func (c *CognitoIdentity) DeleteIdentityPoolWithContext(ctx aws.Context, input *DeleteIdentityPoolInput, opts ...request.Option) (*DeleteIdentityPoolOutput, error)
DeleteIdentityPoolWithContext is the same as DeleteIdentityPool with the addition of the ability to pass a context and additional request options.
See DeleteIdentityPool for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CognitoIdentity) DescribeIdentity ¶
func (c *CognitoIdentity) DescribeIdentity(input *DescribeIdentityInput) (*IdentityDescription, error)
DescribeIdentity API operation for Amazon Cognito Identity.
Returns metadata related to the given identity, including when the identity was created and any associated linked logins.
You must use AWS Developer credentials to call this API.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Cognito Identity's API operation DescribeIdentity for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterException "InvalidParameterException" Thrown for missing or bad input parameter(s).
ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown when the requested resource (for example, a dataset or record) does not exist.
ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.
ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown when a request is throttled.
ErrCodeInternalErrorException "InternalErrorException" Thrown when the service encounters an error during processing the request.
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/DescribeIdentity
func (*CognitoIdentity) DescribeIdentityPool ¶
func (c *CognitoIdentity) DescribeIdentityPool(input *DescribeIdentityPoolInput) (*IdentityPool, error)
DescribeIdentityPool API operation for Amazon Cognito Identity.
Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.
You must use AWS Developer credentials to call this API.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Cognito Identity's API operation DescribeIdentityPool for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterException "InvalidParameterException" Thrown for missing or bad input parameter(s).
ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown when the requested resource (for example, a dataset or record) does not exist.
ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.
ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown when a request is throttled.
ErrCodeInternalErrorException "InternalErrorException" Thrown when the service encounters an error during processing the request.
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/DescribeIdentityPool
func (*CognitoIdentity) DescribeIdentityPoolRequest ¶
func (c *CognitoIdentity) DescribeIdentityPoolRequest(input *DescribeIdentityPoolInput) (req *request.Request, output *IdentityPool)
DescribeIdentityPoolRequest generates a "aws/request.Request" representing the client's request for the DescribeIdentityPool operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeIdentityPool for more information on using the DescribeIdentityPool API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeIdentityPoolRequest method. req, resp := client.DescribeIdentityPoolRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/DescribeIdentityPool
func (*CognitoIdentity) DescribeIdentityPoolWithContext ¶ added in v1.9.0
func (c *CognitoIdentity) DescribeIdentityPoolWithContext(ctx aws.Context, input *DescribeIdentityPoolInput, opts ...request.Option) (*IdentityPool, error)
DescribeIdentityPoolWithContext is the same as DescribeIdentityPool with the addition of the ability to pass a context and additional request options.
See DescribeIdentityPool for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CognitoIdentity) DescribeIdentityRequest ¶
func (c *CognitoIdentity) DescribeIdentityRequest(input *DescribeIdentityInput) (req *request.Request, output *IdentityDescription)
DescribeIdentityRequest generates a "aws/request.Request" representing the client's request for the DescribeIdentity operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeIdentity for more information on using the DescribeIdentity API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeIdentityRequest method. req, resp := client.DescribeIdentityRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/DescribeIdentity
func (*CognitoIdentity) DescribeIdentityWithContext ¶ added in v1.9.0
func (c *CognitoIdentity) DescribeIdentityWithContext(ctx aws.Context, input *DescribeIdentityInput, opts ...request.Option) (*IdentityDescription, error)
DescribeIdentityWithContext is the same as DescribeIdentity with the addition of the ability to pass a context and additional request options.
See DescribeIdentity for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CognitoIdentity) GetCredentialsForIdentity ¶
func (c *CognitoIdentity) GetCredentialsForIdentity(input *GetCredentialsForIdentityInput) (*GetCredentialsForIdentityOutput, error)
GetCredentialsForIdentity API operation for Amazon Cognito Identity.
Returns credentials for the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service with the appropriate role for the token.
This is a public API. You do not need any credentials to call this API.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Cognito Identity's API operation GetCredentialsForIdentity for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterException "InvalidParameterException" Thrown for missing or bad input parameter(s).
ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown when the requested resource (for example, a dataset or record) does not exist.
ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.
ErrCodeResourceConflictException "ResourceConflictException" Thrown when a user tries to use a login which is already linked to another account.
ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown when a request is throttled.
ErrCodeInvalidIdentityPoolConfigurationException "InvalidIdentityPoolConfigurationException" Thrown if the identity pool has no role associated for the given auth type (auth/unauth) or if the AssumeRole fails.
ErrCodeInternalErrorException "InternalErrorException" Thrown when the service encounters an error during processing the request.
ErrCodeExternalServiceException "ExternalServiceException" An exception thrown when a dependent service such as Facebook or Twitter is not responding
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/GetCredentialsForIdentity
func (*CognitoIdentity) GetCredentialsForIdentityRequest ¶
func (c *CognitoIdentity) GetCredentialsForIdentityRequest(input *GetCredentialsForIdentityInput) (req *request.Request, output *GetCredentialsForIdentityOutput)
GetCredentialsForIdentityRequest generates a "aws/request.Request" representing the client's request for the GetCredentialsForIdentity operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetCredentialsForIdentity for more information on using the GetCredentialsForIdentity API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetCredentialsForIdentityRequest method. req, resp := client.GetCredentialsForIdentityRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/GetCredentialsForIdentity
func (*CognitoIdentity) GetCredentialsForIdentityWithContext ¶ added in v1.9.0
func (c *CognitoIdentity) GetCredentialsForIdentityWithContext(ctx aws.Context, input *GetCredentialsForIdentityInput, opts ...request.Option) (*GetCredentialsForIdentityOutput, error)
GetCredentialsForIdentityWithContext is the same as GetCredentialsForIdentity with the addition of the ability to pass a context and additional request options.
See GetCredentialsForIdentity for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CognitoIdentity) GetId ¶
func (c *CognitoIdentity) GetId(input *GetIdInput) (*GetIdOutput, error)
GetId API operation for Amazon Cognito Identity.
Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account.
This is a public API. You do not need any credentials to call this API.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Cognito Identity's API operation GetId for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterException "InvalidParameterException" Thrown for missing or bad input parameter(s).
ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown when the requested resource (for example, a dataset or record) does not exist.
ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.
ErrCodeResourceConflictException "ResourceConflictException" Thrown when a user tries to use a login which is already linked to another account.
ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown when a request is throttled.
ErrCodeInternalErrorException "InternalErrorException" Thrown when the service encounters an error during processing the request.
ErrCodeLimitExceededException "LimitExceededException" Thrown when the total number of user pools has exceeded a preset limit.
ErrCodeExternalServiceException "ExternalServiceException" An exception thrown when a dependent service such as Facebook or Twitter is not responding
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/GetId
func (*CognitoIdentity) GetIdRequest ¶
func (c *CognitoIdentity) GetIdRequest(input *GetIdInput) (req *request.Request, output *GetIdOutput)
GetIdRequest generates a "aws/request.Request" representing the client's request for the GetId operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetId for more information on using the GetId API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetIdRequest method. req, resp := client.GetIdRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/GetId
func (*CognitoIdentity) GetIdWithContext ¶ added in v1.9.0
func (c *CognitoIdentity) GetIdWithContext(ctx aws.Context, input *GetIdInput, opts ...request.Option) (*GetIdOutput, error)
GetIdWithContext is the same as GetId with the addition of the ability to pass a context and additional request options.
See GetId for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CognitoIdentity) GetIdentityPoolRoles ¶
func (c *CognitoIdentity) GetIdentityPoolRoles(input *GetIdentityPoolRolesInput) (*GetIdentityPoolRolesOutput, error)
GetIdentityPoolRoles API operation for Amazon Cognito Identity.
Gets the roles for an identity pool.
You must use AWS Developer credentials to call this API.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Cognito Identity's API operation GetIdentityPoolRoles for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterException "InvalidParameterException" Thrown for missing or bad input parameter(s).
ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown when the requested resource (for example, a dataset or record) does not exist.
ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.
ErrCodeResourceConflictException "ResourceConflictException" Thrown when a user tries to use a login which is already linked to another account.
ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown when a request is throttled.
ErrCodeInternalErrorException "InternalErrorException" Thrown when the service encounters an error during processing the request.
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/GetIdentityPoolRoles
func (*CognitoIdentity) GetIdentityPoolRolesRequest ¶
func (c *CognitoIdentity) GetIdentityPoolRolesRequest(input *GetIdentityPoolRolesInput) (req *request.Request, output *GetIdentityPoolRolesOutput)
GetIdentityPoolRolesRequest generates a "aws/request.Request" representing the client's request for the GetIdentityPoolRoles operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetIdentityPoolRoles for more information on using the GetIdentityPoolRoles API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetIdentityPoolRolesRequest method. req, resp := client.GetIdentityPoolRolesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/GetIdentityPoolRoles
func (*CognitoIdentity) GetIdentityPoolRolesWithContext ¶ added in v1.9.0
func (c *CognitoIdentity) GetIdentityPoolRolesWithContext(ctx aws.Context, input *GetIdentityPoolRolesInput, opts ...request.Option) (*GetIdentityPoolRolesOutput, error)
GetIdentityPoolRolesWithContext is the same as GetIdentityPoolRoles with the addition of the ability to pass a context and additional request options.
See GetIdentityPoolRoles for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CognitoIdentity) GetOpenIdToken ¶
func (c *CognitoIdentity) GetOpenIdToken(input *GetOpenIdTokenInput) (*GetOpenIdTokenOutput, error)
GetOpenIdToken API operation for Amazon Cognito Identity.
Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by GetId. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link.
The OpenId token is valid for 15 minutes.
This is a public API. You do not need any credentials to call this API.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Cognito Identity's API operation GetOpenIdToken for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterException "InvalidParameterException" Thrown for missing or bad input parameter(s).
ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown when the requested resource (for example, a dataset or record) does not exist.
ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.
ErrCodeResourceConflictException "ResourceConflictException" Thrown when a user tries to use a login which is already linked to another account.
ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown when a request is throttled.
ErrCodeInternalErrorException "InternalErrorException" Thrown when the service encounters an error during processing the request.
ErrCodeExternalServiceException "ExternalServiceException" An exception thrown when a dependent service such as Facebook or Twitter is not responding
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/GetOpenIdToken
func (*CognitoIdentity) GetOpenIdTokenForDeveloperIdentity ¶
func (c *CognitoIdentity) GetOpenIdTokenForDeveloperIdentity(input *GetOpenIdTokenForDeveloperIdentityInput) (*GetOpenIdTokenForDeveloperIdentityOutput, error)
GetOpenIdTokenForDeveloperIdentity API operation for Amazon Cognito Identity.
Registers (or retrieves) a Cognito IdentityId and an OpenID Connect token for a user authenticated by your backend authentication process. Supplying multiple logins will create an implicit linked account. You can only specify one developer provider as part of the Logins map, which is linked to the identity pool. The developer provider is the "domain" by which Cognito will refer to your users.
You can use GetOpenIdTokenForDeveloperIdentity to create a new identity and to link new logins (that is, user credentials issued by a public provider or developer provider) to an existing identity. When you want to create a new identity, the IdentityId should be null. When you want to associate a new login with an existing authenticated/unauthenticated identity, you can do so by providing the existing IdentityId. This API will create the identity in the specified IdentityPoolId.
You must use AWS Developer credentials to call this API.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Cognito Identity's API operation GetOpenIdTokenForDeveloperIdentity for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterException "InvalidParameterException" Thrown for missing or bad input parameter(s).
ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown when the requested resource (for example, a dataset or record) does not exist.
ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.
ErrCodeResourceConflictException "ResourceConflictException" Thrown when a user tries to use a login which is already linked to another account.
ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown when a request is throttled.
ErrCodeInternalErrorException "InternalErrorException" Thrown when the service encounters an error during processing the request.
ErrCodeDeveloperUserAlreadyRegisteredException "DeveloperUserAlreadyRegisteredException" The provided developer user identifier is already registered with Cognito under a different identity ID.
func (*CognitoIdentity) GetOpenIdTokenForDeveloperIdentityRequest ¶
func (c *CognitoIdentity) GetOpenIdTokenForDeveloperIdentityRequest(input *GetOpenIdTokenForDeveloperIdentityInput) (req *request.Request, output *GetOpenIdTokenForDeveloperIdentityOutput)
GetOpenIdTokenForDeveloperIdentityRequest generates a "aws/request.Request" representing the client's request for the GetOpenIdTokenForDeveloperIdentity operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetOpenIdTokenForDeveloperIdentity for more information on using the GetOpenIdTokenForDeveloperIdentity API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetOpenIdTokenForDeveloperIdentityRequest method. req, resp := client.GetOpenIdTokenForDeveloperIdentityRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CognitoIdentity) GetOpenIdTokenForDeveloperIdentityWithContext ¶ added in v1.9.0
func (c *CognitoIdentity) GetOpenIdTokenForDeveloperIdentityWithContext(ctx aws.Context, input *GetOpenIdTokenForDeveloperIdentityInput, opts ...request.Option) (*GetOpenIdTokenForDeveloperIdentityOutput, error)
GetOpenIdTokenForDeveloperIdentityWithContext is the same as GetOpenIdTokenForDeveloperIdentity with the addition of the ability to pass a context and additional request options.
See GetOpenIdTokenForDeveloperIdentity for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CognitoIdentity) GetOpenIdTokenRequest ¶
func (c *CognitoIdentity) GetOpenIdTokenRequest(input *GetOpenIdTokenInput) (req *request.Request, output *GetOpenIdTokenOutput)
GetOpenIdTokenRequest generates a "aws/request.Request" representing the client's request for the GetOpenIdToken operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetOpenIdToken for more information on using the GetOpenIdToken API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetOpenIdTokenRequest method. req, resp := client.GetOpenIdTokenRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/GetOpenIdToken
func (*CognitoIdentity) GetOpenIdTokenWithContext ¶ added in v1.9.0
func (c *CognitoIdentity) GetOpenIdTokenWithContext(ctx aws.Context, input *GetOpenIdTokenInput, opts ...request.Option) (*GetOpenIdTokenOutput, error)
GetOpenIdTokenWithContext is the same as GetOpenIdToken with the addition of the ability to pass a context and additional request options.
See GetOpenIdToken for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CognitoIdentity) ListIdentities ¶
func (c *CognitoIdentity) ListIdentities(input *ListIdentitiesInput) (*ListIdentitiesOutput, error)
ListIdentities API operation for Amazon Cognito Identity.
Lists the identities in a pool.
You must use AWS Developer credentials to call this API.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Cognito Identity's API operation ListIdentities for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterException "InvalidParameterException" Thrown for missing or bad input parameter(s).
ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown when the requested resource (for example, a dataset or record) does not exist.
ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.
ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown when a request is throttled.
ErrCodeInternalErrorException "InternalErrorException" Thrown when the service encounters an error during processing the request.
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/ListIdentities
func (*CognitoIdentity) ListIdentitiesRequest ¶
func (c *CognitoIdentity) ListIdentitiesRequest(input *ListIdentitiesInput) (req *request.Request, output *ListIdentitiesOutput)
ListIdentitiesRequest generates a "aws/request.Request" representing the client's request for the ListIdentities operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListIdentities for more information on using the ListIdentities API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListIdentitiesRequest method. req, resp := client.ListIdentitiesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/ListIdentities
func (*CognitoIdentity) ListIdentitiesWithContext ¶ added in v1.9.0
func (c *CognitoIdentity) ListIdentitiesWithContext(ctx aws.Context, input *ListIdentitiesInput, opts ...request.Option) (*ListIdentitiesOutput, error)
ListIdentitiesWithContext is the same as ListIdentities with the addition of the ability to pass a context and additional request options.
See ListIdentities for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CognitoIdentity) ListIdentityPools ¶
func (c *CognitoIdentity) ListIdentityPools(input *ListIdentityPoolsInput) (*ListIdentityPoolsOutput, error)
ListIdentityPools API operation for Amazon Cognito Identity.
Lists all of the Cognito identity pools registered for your account.
You must use AWS Developer credentials to call this API.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Cognito Identity's API operation ListIdentityPools for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterException "InvalidParameterException" Thrown for missing or bad input parameter(s).
ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.
ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown when a request is throttled.
ErrCodeInternalErrorException "InternalErrorException" Thrown when the service encounters an error during processing the request.
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/ListIdentityPools
func (*CognitoIdentity) ListIdentityPoolsRequest ¶
func (c *CognitoIdentity) ListIdentityPoolsRequest(input *ListIdentityPoolsInput) (req *request.Request, output *ListIdentityPoolsOutput)
ListIdentityPoolsRequest generates a "aws/request.Request" representing the client's request for the ListIdentityPools operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListIdentityPools for more information on using the ListIdentityPools API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListIdentityPoolsRequest method. req, resp := client.ListIdentityPoolsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/ListIdentityPools
func (*CognitoIdentity) ListIdentityPoolsWithContext ¶ added in v1.9.0
func (c *CognitoIdentity) ListIdentityPoolsWithContext(ctx aws.Context, input *ListIdentityPoolsInput, opts ...request.Option) (*ListIdentityPoolsOutput, error)
ListIdentityPoolsWithContext is the same as ListIdentityPools with the addition of the ability to pass a context and additional request options.
See ListIdentityPools for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CognitoIdentity) LookupDeveloperIdentity ¶
func (c *CognitoIdentity) LookupDeveloperIdentity(input *LookupDeveloperIdentityInput) (*LookupDeveloperIdentityOutput, error)
LookupDeveloperIdentity API operation for Amazon Cognito Identity.
Retrieves the IdentityID associated with a DeveloperUserIdentifier or the list of DeveloperUserIdentifiers associated with an IdentityId for an existing identity. Either IdentityID or DeveloperUserIdentifier must not be null. If you supply only one of these values, the other value will be searched in the database and returned as a part of the response. If you supply both, DeveloperUserIdentifier will be matched against IdentityID. If the values are verified against the database, the response returns both values and is the same as the request. Otherwise a ResourceConflictException is thrown.
You must use AWS Developer credentials to call this API.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Cognito Identity's API operation LookupDeveloperIdentity for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterException "InvalidParameterException" Thrown for missing or bad input parameter(s).
ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown when the requested resource (for example, a dataset or record) does not exist.
ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.
ErrCodeResourceConflictException "ResourceConflictException" Thrown when a user tries to use a login which is already linked to another account.
ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown when a request is throttled.
ErrCodeInternalErrorException "InternalErrorException" Thrown when the service encounters an error during processing the request.
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/LookupDeveloperIdentity
func (*CognitoIdentity) LookupDeveloperIdentityRequest ¶
func (c *CognitoIdentity) LookupDeveloperIdentityRequest(input *LookupDeveloperIdentityInput) (req *request.Request, output *LookupDeveloperIdentityOutput)
LookupDeveloperIdentityRequest generates a "aws/request.Request" representing the client's request for the LookupDeveloperIdentity operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See LookupDeveloperIdentity for more information on using the LookupDeveloperIdentity API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the LookupDeveloperIdentityRequest method. req, resp := client.LookupDeveloperIdentityRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/LookupDeveloperIdentity
func (*CognitoIdentity) LookupDeveloperIdentityWithContext ¶ added in v1.9.0
func (c *CognitoIdentity) LookupDeveloperIdentityWithContext(ctx aws.Context, input *LookupDeveloperIdentityInput, opts ...request.Option) (*LookupDeveloperIdentityOutput, error)
LookupDeveloperIdentityWithContext is the same as LookupDeveloperIdentity with the addition of the ability to pass a context and additional request options.
See LookupDeveloperIdentity for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CognitoIdentity) MergeDeveloperIdentities ¶
func (c *CognitoIdentity) MergeDeveloperIdentities(input *MergeDeveloperIdentitiesInput) (*MergeDeveloperIdentitiesOutput, error)
MergeDeveloperIdentities API operation for Amazon Cognito Identity.
Merges two users having different IdentityIds, existing in the same identity pool, and identified by the same developer provider. You can use this action to request that discrete users be merged and identified as a single user in the Cognito environment. Cognito associates the given source user (SourceUserIdentifier) with the IdentityId of the DestinationUserIdentifier. Only developer-authenticated users can be merged. If the users to be merged are associated with the same public provider, but as two different users, an exception will be thrown.
You must use AWS Developer credentials to call this API.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Cognito Identity's API operation MergeDeveloperIdentities for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterException "InvalidParameterException" Thrown for missing or bad input parameter(s).
ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown when the requested resource (for example, a dataset or record) does not exist.
ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.
ErrCodeResourceConflictException "ResourceConflictException" Thrown when a user tries to use a login which is already linked to another account.
ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown when a request is throttled.
ErrCodeInternalErrorException "InternalErrorException" Thrown when the service encounters an error during processing the request.
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/MergeDeveloperIdentities
func (*CognitoIdentity) MergeDeveloperIdentitiesRequest ¶
func (c *CognitoIdentity) MergeDeveloperIdentitiesRequest(input *MergeDeveloperIdentitiesInput) (req *request.Request, output *MergeDeveloperIdentitiesOutput)
MergeDeveloperIdentitiesRequest generates a "aws/request.Request" representing the client's request for the MergeDeveloperIdentities operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See MergeDeveloperIdentities for more information on using the MergeDeveloperIdentities API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the MergeDeveloperIdentitiesRequest method. req, resp := client.MergeDeveloperIdentitiesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/MergeDeveloperIdentities
func (*CognitoIdentity) MergeDeveloperIdentitiesWithContext ¶ added in v1.9.0
func (c *CognitoIdentity) MergeDeveloperIdentitiesWithContext(ctx aws.Context, input *MergeDeveloperIdentitiesInput, opts ...request.Option) (*MergeDeveloperIdentitiesOutput, error)
MergeDeveloperIdentitiesWithContext is the same as MergeDeveloperIdentities with the addition of the ability to pass a context and additional request options.
See MergeDeveloperIdentities for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CognitoIdentity) SetIdentityPoolRoles ¶
func (c *CognitoIdentity) SetIdentityPoolRoles(input *SetIdentityPoolRolesInput) (*SetIdentityPoolRolesOutput, error)
SetIdentityPoolRoles API operation for Amazon Cognito Identity.
Sets the roles for an identity pool. These roles are used when making calls to GetCredentialsForIdentity action.
You must use AWS Developer credentials to call this API.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Cognito Identity's API operation SetIdentityPoolRoles for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterException "InvalidParameterException" Thrown for missing or bad input parameter(s).
ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown when the requested resource (for example, a dataset or record) does not exist.
ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.
ErrCodeResourceConflictException "ResourceConflictException" Thrown when a user tries to use a login which is already linked to another account.
ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown when a request is throttled.
ErrCodeInternalErrorException "InternalErrorException" Thrown when the service encounters an error during processing the request.
ErrCodeConcurrentModificationException "ConcurrentModificationException" Thrown if there are parallel requests to modify a resource.
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/SetIdentityPoolRoles
func (*CognitoIdentity) SetIdentityPoolRolesRequest ¶
func (c *CognitoIdentity) SetIdentityPoolRolesRequest(input *SetIdentityPoolRolesInput) (req *request.Request, output *SetIdentityPoolRolesOutput)
SetIdentityPoolRolesRequest generates a "aws/request.Request" representing the client's request for the SetIdentityPoolRoles operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See SetIdentityPoolRoles for more information on using the SetIdentityPoolRoles API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the SetIdentityPoolRolesRequest method. req, resp := client.SetIdentityPoolRolesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/SetIdentityPoolRoles
func (*CognitoIdentity) SetIdentityPoolRolesWithContext ¶ added in v1.9.0
func (c *CognitoIdentity) SetIdentityPoolRolesWithContext(ctx aws.Context, input *SetIdentityPoolRolesInput, opts ...request.Option) (*SetIdentityPoolRolesOutput, error)
SetIdentityPoolRolesWithContext is the same as SetIdentityPoolRoles with the addition of the ability to pass a context and additional request options.
See SetIdentityPoolRoles for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CognitoIdentity) UnlinkDeveloperIdentity ¶
func (c *CognitoIdentity) UnlinkDeveloperIdentity(input *UnlinkDeveloperIdentityInput) (*UnlinkDeveloperIdentityOutput, error)
UnlinkDeveloperIdentity API operation for Amazon Cognito Identity.
Unlinks a DeveloperUserIdentifier from an existing identity. Unlinked developer users will be considered new identities next time they are seen. If, for a given Cognito identity, you remove all federated identities as well as the developer user identifier, the Cognito identity becomes inaccessible.
You must use AWS Developer credentials to call this API.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Cognito Identity's API operation UnlinkDeveloperIdentity for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterException "InvalidParameterException" Thrown for missing or bad input parameter(s).
ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown when the requested resource (for example, a dataset or record) does not exist.
ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.
ErrCodeResourceConflictException "ResourceConflictException" Thrown when a user tries to use a login which is already linked to another account.
ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown when a request is throttled.
ErrCodeInternalErrorException "InternalErrorException" Thrown when the service encounters an error during processing the request.
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/UnlinkDeveloperIdentity
func (*CognitoIdentity) UnlinkDeveloperIdentityRequest ¶
func (c *CognitoIdentity) UnlinkDeveloperIdentityRequest(input *UnlinkDeveloperIdentityInput) (req *request.Request, output *UnlinkDeveloperIdentityOutput)
UnlinkDeveloperIdentityRequest generates a "aws/request.Request" representing the client's request for the UnlinkDeveloperIdentity operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UnlinkDeveloperIdentity for more information on using the UnlinkDeveloperIdentity API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UnlinkDeveloperIdentityRequest method. req, resp := client.UnlinkDeveloperIdentityRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/UnlinkDeveloperIdentity
func (*CognitoIdentity) UnlinkDeveloperIdentityWithContext ¶ added in v1.9.0
func (c *CognitoIdentity) UnlinkDeveloperIdentityWithContext(ctx aws.Context, input *UnlinkDeveloperIdentityInput, opts ...request.Option) (*UnlinkDeveloperIdentityOutput, error)
UnlinkDeveloperIdentityWithContext is the same as UnlinkDeveloperIdentity with the addition of the ability to pass a context and additional request options.
See UnlinkDeveloperIdentity for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CognitoIdentity) UnlinkIdentity ¶
func (c *CognitoIdentity) UnlinkIdentity(input *UnlinkIdentityInput) (*UnlinkIdentityOutput, error)
UnlinkIdentity API operation for Amazon Cognito Identity.
Unlinks a federated identity from an existing account. Unlinked logins will be considered new identities next time they are seen. Removing the last linked login will make this identity inaccessible.
This is a public API. You do not need any credentials to call this API.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Cognito Identity's API operation UnlinkIdentity for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterException "InvalidParameterException" Thrown for missing or bad input parameter(s).
ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown when the requested resource (for example, a dataset or record) does not exist.
ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.
ErrCodeResourceConflictException "ResourceConflictException" Thrown when a user tries to use a login which is already linked to another account.
ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown when a request is throttled.
ErrCodeInternalErrorException "InternalErrorException" Thrown when the service encounters an error during processing the request.
ErrCodeExternalServiceException "ExternalServiceException" An exception thrown when a dependent service such as Facebook or Twitter is not responding
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/UnlinkIdentity
func (*CognitoIdentity) UnlinkIdentityRequest ¶
func (c *CognitoIdentity) UnlinkIdentityRequest(input *UnlinkIdentityInput) (req *request.Request, output *UnlinkIdentityOutput)
UnlinkIdentityRequest generates a "aws/request.Request" representing the client's request for the UnlinkIdentity operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UnlinkIdentity for more information on using the UnlinkIdentity API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UnlinkIdentityRequest method. req, resp := client.UnlinkIdentityRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/UnlinkIdentity
func (*CognitoIdentity) UnlinkIdentityWithContext ¶ added in v1.9.0
func (c *CognitoIdentity) UnlinkIdentityWithContext(ctx aws.Context, input *UnlinkIdentityInput, opts ...request.Option) (*UnlinkIdentityOutput, error)
UnlinkIdentityWithContext is the same as UnlinkIdentity with the addition of the ability to pass a context and additional request options.
See UnlinkIdentity for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CognitoIdentity) UpdateIdentityPool ¶
func (c *CognitoIdentity) UpdateIdentityPool(input *IdentityPool) (*IdentityPool, error)
UpdateIdentityPool API operation for Amazon Cognito Identity.
Updates a user pool.
You must use AWS Developer credentials to call this API.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Cognito Identity's API operation UpdateIdentityPool for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterException "InvalidParameterException" Thrown for missing or bad input parameter(s).
ErrCodeResourceNotFoundException "ResourceNotFoundException" Thrown when the requested resource (for example, a dataset or record) does not exist.
ErrCodeNotAuthorizedException "NotAuthorizedException" Thrown when a user is not authorized to access the requested resource.
ErrCodeResourceConflictException "ResourceConflictException" Thrown when a user tries to use a login which is already linked to another account.
ErrCodeTooManyRequestsException "TooManyRequestsException" Thrown when a request is throttled.
ErrCodeInternalErrorException "InternalErrorException" Thrown when the service encounters an error during processing the request.
ErrCodeConcurrentModificationException "ConcurrentModificationException" Thrown if there are parallel requests to modify a resource.
ErrCodeLimitExceededException "LimitExceededException" Thrown when the total number of user pools has exceeded a preset limit.
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/UpdateIdentityPool
func (*CognitoIdentity) UpdateIdentityPoolRequest ¶
func (c *CognitoIdentity) UpdateIdentityPoolRequest(input *IdentityPool) (req *request.Request, output *IdentityPool)
UpdateIdentityPoolRequest generates a "aws/request.Request" representing the client's request for the UpdateIdentityPool operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateIdentityPool for more information on using the UpdateIdentityPool API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UpdateIdentityPoolRequest method. req, resp := client.UpdateIdentityPoolRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/UpdateIdentityPool
func (*CognitoIdentity) UpdateIdentityPoolWithContext ¶ added in v1.9.0
func (c *CognitoIdentity) UpdateIdentityPoolWithContext(ctx aws.Context, input *IdentityPool, opts ...request.Option) (*IdentityPool, error)
UpdateIdentityPoolWithContext is the same as UpdateIdentityPool with the addition of the ability to pass a context and additional request options.
See UpdateIdentityPool for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
type 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.
func (CreateIdentityPoolInput) GoString ¶
func (s CreateIdentityPoolInput) GoString() string
GoString returns the string representation
func (*CreateIdentityPoolInput) SetAllowUnauthenticatedIdentities ¶ added in v1.6.16
func (s *CreateIdentityPoolInput) SetAllowUnauthenticatedIdentities(v bool) *CreateIdentityPoolInput
SetAllowUnauthenticatedIdentities sets the AllowUnauthenticatedIdentities field's value.
func (*CreateIdentityPoolInput) SetCognitoIdentityProviders ¶ added in v1.6.16
func (s *CreateIdentityPoolInput) SetCognitoIdentityProviders(v []*Provider) *CreateIdentityPoolInput
SetCognitoIdentityProviders sets the CognitoIdentityProviders field's value.
func (*CreateIdentityPoolInput) SetDeveloperProviderName ¶ added in v1.6.16
func (s *CreateIdentityPoolInput) SetDeveloperProviderName(v string) *CreateIdentityPoolInput
SetDeveloperProviderName sets the DeveloperProviderName field's value.
func (*CreateIdentityPoolInput) SetIdentityPoolName ¶ added in v1.6.16
func (s *CreateIdentityPoolInput) SetIdentityPoolName(v string) *CreateIdentityPoolInput
SetIdentityPoolName sets the IdentityPoolName field's value.
func (*CreateIdentityPoolInput) SetOpenIdConnectProviderARNs ¶ added in v1.6.16
func (s *CreateIdentityPoolInput) SetOpenIdConnectProviderARNs(v []*string) *CreateIdentityPoolInput
SetOpenIdConnectProviderARNs sets the OpenIdConnectProviderARNs field's value.
func (*CreateIdentityPoolInput) SetSamlProviderARNs ¶ added in v1.6.16
func (s *CreateIdentityPoolInput) SetSamlProviderARNs(v []*string) *CreateIdentityPoolInput
SetSamlProviderARNs sets the SamlProviderARNs field's value.
func (*CreateIdentityPoolInput) SetSupportedLoginProviders ¶ added in v1.6.16
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 ¶ added in v1.3.0
func (s *CreateIdentityPoolInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type Credentials ¶
type Credentials struct { // The Access Key portion of the credentials. AccessKeyId *string `type:"string"` // The date at which these credentials will expire. Expiration *time.Time `type:"timestamp" 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.
func (Credentials) GoString ¶
func (s Credentials) GoString() string
GoString returns the string representation
func (*Credentials) SetAccessKeyId ¶ added in v1.6.16
func (s *Credentials) SetAccessKeyId(v string) *Credentials
SetAccessKeyId sets the AccessKeyId field's value.
func (*Credentials) SetExpiration ¶ added in v1.6.16
func (s *Credentials) SetExpiration(v time.Time) *Credentials
SetExpiration sets the Expiration field's value.
func (*Credentials) SetSecretKey ¶ added in v1.6.16
func (s *Credentials) SetSecretKey(v string) *Credentials
SetSecretKey sets the SecretKey field's value.
func (*Credentials) SetSessionToken ¶ added in v1.6.16
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.
func (DeleteIdentitiesInput) GoString ¶
func (s DeleteIdentitiesInput) GoString() string
GoString returns the string representation
func (*DeleteIdentitiesInput) SetIdentityIdsToDelete ¶ added in v1.6.16
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 ¶ added in v1.3.0
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.
func (DeleteIdentitiesOutput) GoString ¶
func (s DeleteIdentitiesOutput) GoString() string
GoString returns the string representation
func (*DeleteIdentitiesOutput) SetUnprocessedIdentityIds ¶ added in v1.6.16
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 DeleteIdentityPoolInput ¶
type DeleteIdentityPoolInput struct { // An identity pool ID in the format REGION:GUID. // // IdentityPoolId is a required field IdentityPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Input to the DeleteIdentityPool action.
func (DeleteIdentityPoolInput) GoString ¶
func (s DeleteIdentityPoolInput) GoString() string
GoString returns the string representation
func (*DeleteIdentityPoolInput) SetIdentityPoolId ¶ added in v1.6.16
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 ¶ added in v1.3.0
func (s *DeleteIdentityPoolInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteIdentityPoolOutput ¶
type DeleteIdentityPoolOutput struct {
// contains filtered or unexported fields
}
func (DeleteIdentityPoolOutput) GoString ¶
func (s DeleteIdentityPoolOutput) GoString() string
GoString returns the string representation
func (DeleteIdentityPoolOutput) String ¶
func (s DeleteIdentityPoolOutput) String() string
String returns the string representation
type DescribeIdentityInput ¶
type DescribeIdentityInput struct { // A unique identifier in the format REGION:GUID. // // IdentityId is a required field IdentityId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Input to the DescribeIdentity action.
func (DescribeIdentityInput) GoString ¶
func (s DescribeIdentityInput) GoString() string
GoString returns the string representation
func (*DescribeIdentityInput) SetIdentityId ¶ added in v1.6.16
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 ¶ added in v1.3.0
func (s *DescribeIdentityInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeIdentityPoolInput ¶
type DescribeIdentityPoolInput struct { // An identity pool ID in the format REGION:GUID. // // IdentityPoolId is a required field IdentityPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Input to the DescribeIdentityPool action.
func (DescribeIdentityPoolInput) GoString ¶
func (s DescribeIdentityPoolInput) GoString() string
GoString returns the string representation
func (*DescribeIdentityPoolInput) SetIdentityPoolId ¶ added in v1.6.16
func (s *DescribeIdentityPoolInput) SetIdentityPoolId(v string) *DescribeIdentityPoolInput
SetIdentityPoolId sets the IdentityPoolId field's value.
func (DescribeIdentityPoolInput) String ¶
func (s DescribeIdentityPoolInput) String() string
String returns the string representation
func (*DescribeIdentityPoolInput) Validate ¶ added in v1.3.0
func (s *DescribeIdentityPoolInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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.
func (GetCredentialsForIdentityInput) GoString ¶
func (s GetCredentialsForIdentityInput) GoString() string
GoString returns the string representation
func (*GetCredentialsForIdentityInput) SetCustomRoleArn ¶ added in v1.6.16
func (s *GetCredentialsForIdentityInput) SetCustomRoleArn(v string) *GetCredentialsForIdentityInput
SetCustomRoleArn sets the CustomRoleArn field's value.
func (*GetCredentialsForIdentityInput) SetIdentityId ¶ added in v1.6.16
func (s *GetCredentialsForIdentityInput) SetIdentityId(v string) *GetCredentialsForIdentityInput
SetIdentityId sets the IdentityId field's value.
func (*GetCredentialsForIdentityInput) SetLogins ¶ added in v1.6.16
func (s *GetCredentialsForIdentityInput) SetLogins(v map[string]*string) *GetCredentialsForIdentityInput
SetLogins sets the Logins field's value.
func (GetCredentialsForIdentityInput) String ¶
func (s GetCredentialsForIdentityInput) String() string
String returns the string representation
func (*GetCredentialsForIdentityInput) Validate ¶ added in v1.3.0
func (s *GetCredentialsForIdentityInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetCredentialsForIdentityOutput ¶
type GetCredentialsForIdentityOutput struct { // Credentials for the provided identity ID. Credentials *Credentials `type:"structure"` // A unique identifier in the format REGION:GUID. IdentityId *string `min:"1" type:"string"` // contains filtered or unexported fields }
Returned in response to a successful GetCredentialsForIdentity operation.
func (GetCredentialsForIdentityOutput) GoString ¶
func (s GetCredentialsForIdentityOutput) GoString() string
GoString returns the string representation
func (*GetCredentialsForIdentityOutput) SetCredentials ¶ added in v1.6.16
func (s *GetCredentialsForIdentityOutput) SetCredentials(v *Credentials) *GetCredentialsForIdentityOutput
SetCredentials sets the Credentials field's value.
func (*GetCredentialsForIdentityOutput) SetIdentityId ¶ added in v1.6.16
func (s *GetCredentialsForIdentityOutput) SetIdentityId(v string) *GetCredentialsForIdentityOutput
SetIdentityId sets the IdentityId field's value.
func (GetCredentialsForIdentityOutput) String ¶
func (s GetCredentialsForIdentityOutput) String() string
String returns the string representation
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.
func (GetIdInput) GoString ¶
func (s GetIdInput) GoString() string
GoString returns the string representation
func (*GetIdInput) SetAccountId ¶ added in v1.6.16
func (s *GetIdInput) SetAccountId(v string) *GetIdInput
SetAccountId sets the AccountId field's value.
func (*GetIdInput) SetIdentityPoolId ¶ added in v1.6.16
func (s *GetIdInput) SetIdentityPoolId(v string) *GetIdInput
SetIdentityPoolId sets the IdentityPoolId field's value.
func (*GetIdInput) SetLogins ¶ added in v1.6.16
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 ¶ added in v1.3.0
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.
func (GetIdOutput) GoString ¶
func (s GetIdOutput) GoString() string
GoString returns the string representation
func (*GetIdOutput) SetIdentityId ¶ added in v1.6.16
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 GetIdentityPoolRolesInput ¶
type GetIdentityPoolRolesInput struct { // An identity pool ID in the format REGION:GUID. // // IdentityPoolId is a required field IdentityPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Input to the GetIdentityPoolRoles action.
func (GetIdentityPoolRolesInput) GoString ¶
func (s GetIdentityPoolRolesInput) GoString() string
GoString returns the string representation
func (*GetIdentityPoolRolesInput) SetIdentityPoolId ¶ added in v1.6.16
func (s *GetIdentityPoolRolesInput) SetIdentityPoolId(v string) *GetIdentityPoolRolesInput
SetIdentityPoolId sets the IdentityPoolId field's value.
func (GetIdentityPoolRolesInput) String ¶
func (s GetIdentityPoolRolesInput) String() string
String returns the string representation
func (*GetIdentityPoolRolesInput) Validate ¶ added in v1.3.0
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.
func (GetIdentityPoolRolesOutput) GoString ¶
func (s GetIdentityPoolRolesOutput) GoString() string
GoString returns the string representation
func (*GetIdentityPoolRolesOutput) SetIdentityPoolId ¶ added in v1.6.16
func (s *GetIdentityPoolRolesOutput) SetIdentityPoolId(v string) *GetIdentityPoolRolesOutput
SetIdentityPoolId sets the IdentityPoolId field's value.
func (*GetIdentityPoolRolesOutput) SetRoleMappings ¶ added in v1.6.16
func (s *GetIdentityPoolRolesOutput) SetRoleMappings(v map[string]*RoleMapping) *GetIdentityPoolRolesOutput
SetRoleMappings sets the RoleMappings field's value.
func (*GetIdentityPoolRolesOutput) SetRoles ¶ added in v1.6.16
func (s *GetIdentityPoolRolesOutput) SetRoles(v map[string]*string) *GetIdentityPoolRolesOutput
SetRoles sets the Roles field's value.
func (GetIdentityPoolRolesOutput) String ¶
func (s GetIdentityPoolRolesOutput) String() string
String returns the string representation
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.
func (GetOpenIdTokenForDeveloperIdentityInput) GoString ¶
func (s GetOpenIdTokenForDeveloperIdentityInput) GoString() string
GoString returns the string representation
func (*GetOpenIdTokenForDeveloperIdentityInput) SetIdentityId ¶ added in v1.6.16
func (s *GetOpenIdTokenForDeveloperIdentityInput) SetIdentityId(v string) *GetOpenIdTokenForDeveloperIdentityInput
SetIdentityId sets the IdentityId field's value.
func (*GetOpenIdTokenForDeveloperIdentityInput) SetIdentityPoolId ¶ added in v1.6.16
func (s *GetOpenIdTokenForDeveloperIdentityInput) SetIdentityPoolId(v string) *GetOpenIdTokenForDeveloperIdentityInput
SetIdentityPoolId sets the IdentityPoolId field's value.
func (*GetOpenIdTokenForDeveloperIdentityInput) SetLogins ¶ added in v1.6.16
func (s *GetOpenIdTokenForDeveloperIdentityInput) SetLogins(v map[string]*string) *GetOpenIdTokenForDeveloperIdentityInput
SetLogins sets the Logins field's value.
func (*GetOpenIdTokenForDeveloperIdentityInput) SetTokenDuration ¶ added in v1.6.16
func (s *GetOpenIdTokenForDeveloperIdentityInput) SetTokenDuration(v int64) *GetOpenIdTokenForDeveloperIdentityInput
SetTokenDuration sets the TokenDuration field's value.
func (GetOpenIdTokenForDeveloperIdentityInput) String ¶
func (s GetOpenIdTokenForDeveloperIdentityInput) String() string
String returns the string representation
func (*GetOpenIdTokenForDeveloperIdentityInput) Validate ¶ added in v1.3.0
func (s *GetOpenIdTokenForDeveloperIdentityInput) Validate() error
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.
func (GetOpenIdTokenForDeveloperIdentityOutput) GoString ¶
func (s GetOpenIdTokenForDeveloperIdentityOutput) GoString() string
GoString returns the string representation
func (*GetOpenIdTokenForDeveloperIdentityOutput) SetIdentityId ¶ added in v1.6.16
func (s *GetOpenIdTokenForDeveloperIdentityOutput) SetIdentityId(v string) *GetOpenIdTokenForDeveloperIdentityOutput
SetIdentityId sets the IdentityId field's value.
func (*GetOpenIdTokenForDeveloperIdentityOutput) SetToken ¶ added in v1.6.16
func (s *GetOpenIdTokenForDeveloperIdentityOutput) SetToken(v string) *GetOpenIdTokenForDeveloperIdentityOutput
SetToken sets the Token field's value.
func (GetOpenIdTokenForDeveloperIdentityOutput) String ¶
func (s GetOpenIdTokenForDeveloperIdentityOutput) String() string
String returns the string representation
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.
func (GetOpenIdTokenInput) GoString ¶
func (s GetOpenIdTokenInput) GoString() string
GoString returns the string representation
func (*GetOpenIdTokenInput) SetIdentityId ¶ added in v1.6.16
func (s *GetOpenIdTokenInput) SetIdentityId(v string) *GetOpenIdTokenInput
SetIdentityId sets the IdentityId field's value.
func (*GetOpenIdTokenInput) SetLogins ¶ added in v1.6.16
func (s *GetOpenIdTokenInput) SetLogins(v map[string]*string) *GetOpenIdTokenInput
SetLogins sets the Logins field's value.
func (GetOpenIdTokenInput) String ¶
func (s GetOpenIdTokenInput) String() string
String returns the string representation
func (*GetOpenIdTokenInput) Validate ¶ added in v1.3.0
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.
func (GetOpenIdTokenOutput) GoString ¶
func (s GetOpenIdTokenOutput) GoString() string
GoString returns the string representation
func (*GetOpenIdTokenOutput) SetIdentityId ¶ added in v1.6.16
func (s *GetOpenIdTokenOutput) SetIdentityId(v string) *GetOpenIdTokenOutput
SetIdentityId sets the IdentityId field's value.
func (*GetOpenIdTokenOutput) SetToken ¶ added in v1.6.16
func (s *GetOpenIdTokenOutput) SetToken(v string) *GetOpenIdTokenOutput
SetToken sets the Token field's value.
func (GetOpenIdTokenOutput) String ¶
func (s GetOpenIdTokenOutput) String() string
String returns the string representation
type IdentityDescription ¶
type IdentityDescription 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.
func (IdentityDescription) GoString ¶
func (s IdentityDescription) GoString() string
GoString returns the string representation
func (*IdentityDescription) SetCreationDate ¶ added in v1.6.16
func (s *IdentityDescription) SetCreationDate(v time.Time) *IdentityDescription
SetCreationDate sets the CreationDate field's value.
func (*IdentityDescription) SetIdentityId ¶ added in v1.6.16
func (s *IdentityDescription) SetIdentityId(v string) *IdentityDescription
SetIdentityId sets the IdentityId field's value.
func (*IdentityDescription) SetLastModifiedDate ¶ added in v1.6.16
func (s *IdentityDescription) SetLastModifiedDate(v time.Time) *IdentityDescription
SetLastModifiedDate sets the LastModifiedDate field's value.
func (*IdentityDescription) SetLogins ¶ added in v1.6.16
func (s *IdentityDescription) SetLogins(v []*string) *IdentityDescription
SetLogins sets the Logins field's value.
func (IdentityDescription) String ¶
func (s IdentityDescription) String() string
String returns the string representation
type IdentityPool ¶
type IdentityPool 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.
func (IdentityPool) GoString ¶
func (s IdentityPool) GoString() string
GoString returns the string representation
func (*IdentityPool) SetAllowUnauthenticatedIdentities ¶ added in v1.6.16
func (s *IdentityPool) SetAllowUnauthenticatedIdentities(v bool) *IdentityPool
SetAllowUnauthenticatedIdentities sets the AllowUnauthenticatedIdentities field's value.
func (*IdentityPool) SetCognitoIdentityProviders ¶ added in v1.6.16
func (s *IdentityPool) SetCognitoIdentityProviders(v []*Provider) *IdentityPool
SetCognitoIdentityProviders sets the CognitoIdentityProviders field's value.
func (*IdentityPool) SetDeveloperProviderName ¶ added in v1.6.16
func (s *IdentityPool) SetDeveloperProviderName(v string) *IdentityPool
SetDeveloperProviderName sets the DeveloperProviderName field's value.
func (*IdentityPool) SetIdentityPoolId ¶ added in v1.6.16
func (s *IdentityPool) SetIdentityPoolId(v string) *IdentityPool
SetIdentityPoolId sets the IdentityPoolId field's value.
func (*IdentityPool) SetIdentityPoolName ¶ added in v1.6.16
func (s *IdentityPool) SetIdentityPoolName(v string) *IdentityPool
SetIdentityPoolName sets the IdentityPoolName field's value.
func (*IdentityPool) SetOpenIdConnectProviderARNs ¶ added in v1.6.16
func (s *IdentityPool) SetOpenIdConnectProviderARNs(v []*string) *IdentityPool
SetOpenIdConnectProviderARNs sets the OpenIdConnectProviderARNs field's value.
func (*IdentityPool) SetSamlProviderARNs ¶ added in v1.6.16
func (s *IdentityPool) SetSamlProviderARNs(v []*string) *IdentityPool
SetSamlProviderARNs sets the SamlProviderARNs field's value.
func (*IdentityPool) SetSupportedLoginProviders ¶ added in v1.6.16
func (s *IdentityPool) SetSupportedLoginProviders(v map[string]*string) *IdentityPool
SetSupportedLoginProviders sets the SupportedLoginProviders field's value.
func (IdentityPool) String ¶
func (s IdentityPool) String() string
String returns the string representation
func (*IdentityPool) Validate ¶ added in v1.3.0
func (s *IdentityPool) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type IdentityPoolShortDescription ¶
type IdentityPoolShortDescription struct { // An identity pool ID in the format REGION:GUID. IdentityPoolId *string `min:"1" type:"string"` // A string that you provide. IdentityPoolName *string `min:"1" type:"string"` // contains filtered or unexported fields }
A description of the identity pool.
func (IdentityPoolShortDescription) GoString ¶
func (s IdentityPoolShortDescription) GoString() string
GoString returns the string representation
func (*IdentityPoolShortDescription) SetIdentityPoolId ¶ added in v1.6.16
func (s *IdentityPoolShortDescription) SetIdentityPoolId(v string) *IdentityPoolShortDescription
SetIdentityPoolId sets the IdentityPoolId field's value.
func (*IdentityPoolShortDescription) SetIdentityPoolName ¶ added in v1.6.16
func (s *IdentityPoolShortDescription) SetIdentityPoolName(v string) *IdentityPoolShortDescription
SetIdentityPoolName sets the IdentityPoolName field's value.
func (IdentityPoolShortDescription) String ¶
func (s IdentityPoolShortDescription) String() 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.
func (ListIdentitiesInput) GoString ¶
func (s ListIdentitiesInput) GoString() string
GoString returns the string representation
func (*ListIdentitiesInput) SetHideDisabled ¶ added in v1.6.16
func (s *ListIdentitiesInput) SetHideDisabled(v bool) *ListIdentitiesInput
SetHideDisabled sets the HideDisabled field's value.
func (*ListIdentitiesInput) SetIdentityPoolId ¶ added in v1.6.16
func (s *ListIdentitiesInput) SetIdentityPoolId(v string) *ListIdentitiesInput
SetIdentityPoolId sets the IdentityPoolId field's value.
func (*ListIdentitiesInput) SetMaxResults ¶ added in v1.6.16
func (s *ListIdentitiesInput) SetMaxResults(v int64) *ListIdentitiesInput
SetMaxResults sets the MaxResults field's value.
func (*ListIdentitiesInput) SetNextToken ¶ added in v1.6.16
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 ¶ added in v1.3.0
func (s *ListIdentitiesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListIdentitiesOutput ¶
type ListIdentitiesOutput struct { // An object containing a set of identities and associated mappings. Identities []*IdentityDescription `type:"list"` // An identity pool ID in the format REGION:GUID. IdentityPoolId *string `min:"1" type:"string"` // A pagination token. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
The response to a ListIdentities request.
func (ListIdentitiesOutput) GoString ¶
func (s ListIdentitiesOutput) GoString() string
GoString returns the string representation
func (*ListIdentitiesOutput) SetIdentities ¶ added in v1.6.16
func (s *ListIdentitiesOutput) SetIdentities(v []*IdentityDescription) *ListIdentitiesOutput
SetIdentities sets the Identities field's value.
func (*ListIdentitiesOutput) SetIdentityPoolId ¶ added in v1.6.16
func (s *ListIdentitiesOutput) SetIdentityPoolId(v string) *ListIdentitiesOutput
SetIdentityPoolId sets the IdentityPoolId field's value.
func (*ListIdentitiesOutput) SetNextToken ¶ added in v1.6.16
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 ListIdentityPoolsInput ¶
type ListIdentityPoolsInput struct { // The maximum number of identities to return. // // MaxResults is a required field MaxResults *int64 `min:"1" type:"integer" required:"true"` // A pagination token. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
Input to the ListIdentityPools action.
func (ListIdentityPoolsInput) GoString ¶
func (s ListIdentityPoolsInput) GoString() string
GoString returns the string representation
func (*ListIdentityPoolsInput) SetMaxResults ¶ added in v1.6.16
func (s *ListIdentityPoolsInput) SetMaxResults(v int64) *ListIdentityPoolsInput
SetMaxResults sets the MaxResults field's value.
func (*ListIdentityPoolsInput) SetNextToken ¶ added in v1.6.16
func (s *ListIdentityPoolsInput) SetNextToken(v string) *ListIdentityPoolsInput
SetNextToken sets the NextToken field's value.
func (ListIdentityPoolsInput) String ¶
func (s ListIdentityPoolsInput) String() string
String returns the string representation
func (*ListIdentityPoolsInput) Validate ¶ added in v1.3.0
func (s *ListIdentityPoolsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListIdentityPoolsOutput ¶
type ListIdentityPoolsOutput struct { // The identity pools returned by the ListIdentityPools action. IdentityPools []*IdentityPoolShortDescription `type:"list"` // A pagination token. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
The result of a successful ListIdentityPools action.
func (ListIdentityPoolsOutput) GoString ¶
func (s ListIdentityPoolsOutput) GoString() string
GoString returns the string representation
func (*ListIdentityPoolsOutput) SetIdentityPools ¶ added in v1.6.16
func (s *ListIdentityPoolsOutput) SetIdentityPools(v []*IdentityPoolShortDescription) *ListIdentityPoolsOutput
SetIdentityPools sets the IdentityPools field's value.
func (*ListIdentityPoolsOutput) SetNextToken ¶ added in v1.6.16
func (s *ListIdentityPoolsOutput) SetNextToken(v string) *ListIdentityPoolsOutput
SetNextToken sets the NextToken field's value.
func (ListIdentityPoolsOutput) String ¶
func (s ListIdentityPoolsOutput) String() string
String returns the string representation
type LookupDeveloperIdentityInput ¶
type LookupDeveloperIdentityInput struct { // A unique ID used by your backend authentication process to identify a user. // Typically, a developer identity provider would issue many developer user // identifiers, in keeping with the number of users. DeveloperUserIdentifier *string `min:"1" type:"string"` // A unique identifier in the format REGION:GUID. IdentityId *string `min:"1" type:"string"` // An identity pool ID in the format REGION:GUID. // // IdentityPoolId is a required field IdentityPoolId *string `min:"1" type:"string" required:"true"` // The maximum number of identities to return. MaxResults *int64 `min:"1" type:"integer"` // A pagination token. The first call you make will have NextToken set to null. // After that the service will return NextToken values as needed. For example, // let's say you make a request with MaxResults set to 10, and there are 20 // matches in the database. The service will return a pagination token as a // part of the response. This token can be used to call the API again and get // results starting from the 11th match. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
Input to the LookupDeveloperIdentityInput action.
func (LookupDeveloperIdentityInput) GoString ¶
func (s LookupDeveloperIdentityInput) GoString() string
GoString returns the string representation
func (*LookupDeveloperIdentityInput) SetDeveloperUserIdentifier ¶ added in v1.6.16
func (s *LookupDeveloperIdentityInput) SetDeveloperUserIdentifier(v string) *LookupDeveloperIdentityInput
SetDeveloperUserIdentifier sets the DeveloperUserIdentifier field's value.
func (*LookupDeveloperIdentityInput) SetIdentityId ¶ added in v1.6.16
func (s *LookupDeveloperIdentityInput) SetIdentityId(v string) *LookupDeveloperIdentityInput
SetIdentityId sets the IdentityId field's value.
func (*LookupDeveloperIdentityInput) SetIdentityPoolId ¶ added in v1.6.16
func (s *LookupDeveloperIdentityInput) SetIdentityPoolId(v string) *LookupDeveloperIdentityInput
SetIdentityPoolId sets the IdentityPoolId field's value.
func (*LookupDeveloperIdentityInput) SetMaxResults ¶ added in v1.6.16
func (s *LookupDeveloperIdentityInput) SetMaxResults(v int64) *LookupDeveloperIdentityInput
SetMaxResults sets the MaxResults field's value.
func (*LookupDeveloperIdentityInput) SetNextToken ¶ added in v1.6.16
func (s *LookupDeveloperIdentityInput) SetNextToken(v string) *LookupDeveloperIdentityInput
SetNextToken sets the NextToken field's value.
func (LookupDeveloperIdentityInput) String ¶
func (s LookupDeveloperIdentityInput) String() string
String returns the string representation
func (*LookupDeveloperIdentityInput) Validate ¶ added in v1.3.0
func (s *LookupDeveloperIdentityInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type LookupDeveloperIdentityOutput ¶
type LookupDeveloperIdentityOutput struct { // This is the list of developer user identifiers associated with an identity // ID. Cognito supports the association of multiple developer user identifiers // with an identity ID. DeveloperUserIdentifierList []*string `type:"list"` // A unique identifier in the format REGION:GUID. IdentityId *string `min:"1" type:"string"` // A pagination token. The first call you make will have NextToken set to null. // After that the service will return NextToken values as needed. For example, // let's say you make a request with MaxResults set to 10, and there are 20 // matches in the database. The service will return a pagination token as a // part of the response. This token can be used to call the API again and get // results starting from the 11th match. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
Returned in response to a successful LookupDeveloperIdentity action.
func (LookupDeveloperIdentityOutput) GoString ¶
func (s LookupDeveloperIdentityOutput) GoString() string
GoString returns the string representation
func (*LookupDeveloperIdentityOutput) SetDeveloperUserIdentifierList ¶ added in v1.6.16
func (s *LookupDeveloperIdentityOutput) SetDeveloperUserIdentifierList(v []*string) *LookupDeveloperIdentityOutput
SetDeveloperUserIdentifierList sets the DeveloperUserIdentifierList field's value.
func (*LookupDeveloperIdentityOutput) SetIdentityId ¶ added in v1.6.16
func (s *LookupDeveloperIdentityOutput) SetIdentityId(v string) *LookupDeveloperIdentityOutput
SetIdentityId sets the IdentityId field's value.
func (*LookupDeveloperIdentityOutput) SetNextToken ¶ added in v1.6.16
func (s *LookupDeveloperIdentityOutput) SetNextToken(v string) *LookupDeveloperIdentityOutput
SetNextToken sets the NextToken field's value.
func (LookupDeveloperIdentityOutput) String ¶
func (s LookupDeveloperIdentityOutput) String() string
String returns the string representation
type MappingRule ¶ added in v1.6.16
type MappingRule struct { // The claim name that must be present in the token, for example, "isAdmin" // or "paid". // // Claim is a required field Claim *string `min:"1" type:"string" required:"true"` // The match condition that specifies how closely the claim value in the IdP // token must match Value. // // MatchType is a required field MatchType *string `type:"string" required:"true" enum:"MappingRuleMatchType"` // The role ARN. // // RoleARN is a required field RoleARN *string `min:"20" type:"string" required:"true"` // A brief string that the claim must match, for example, "paid" or "yes". // // Value is a required field Value *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
A rule that maps a claim name, a claim value, and a match type to a role ARN.
func (MappingRule) GoString ¶ added in v1.6.16
func (s MappingRule) GoString() string
GoString returns the string representation
func (*MappingRule) SetClaim ¶ added in v1.6.16
func (s *MappingRule) SetClaim(v string) *MappingRule
SetClaim sets the Claim field's value.
func (*MappingRule) SetMatchType ¶ added in v1.6.16
func (s *MappingRule) SetMatchType(v string) *MappingRule
SetMatchType sets the MatchType field's value.
func (*MappingRule) SetRoleARN ¶ added in v1.6.16
func (s *MappingRule) SetRoleARN(v string) *MappingRule
SetRoleARN sets the RoleARN field's value.
func (*MappingRule) SetValue ¶ added in v1.6.16
func (s *MappingRule) SetValue(v string) *MappingRule
SetValue sets the Value field's value.
func (MappingRule) String ¶ added in v1.6.16
func (s MappingRule) String() string
String returns the string representation
func (*MappingRule) Validate ¶ added in v1.6.16
func (s *MappingRule) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type MergeDeveloperIdentitiesInput ¶
type MergeDeveloperIdentitiesInput struct { // User identifier for the destination user. The value should be a DeveloperUserIdentifier. // // DestinationUserIdentifier is a required field DestinationUserIdentifier *string `min:"1" type:"string" required:"true"` // The "domain" by which Cognito will refer to your users. This is a (pseudo) // domain name that you provide while creating an identity pool. This name acts // as a placeholder that allows your backend and the Cognito service to communicate // about the developer provider. For the DeveloperProviderName, you can use // letters as well as period (.), underscore (_), and dash (-). // // DeveloperProviderName is a required field DeveloperProviderName *string `min:"1" type:"string" required:"true"` // An identity pool ID in the format REGION:GUID. // // IdentityPoolId is a required field IdentityPoolId *string `min:"1" type:"string" required:"true"` // User identifier for the source user. The value should be a DeveloperUserIdentifier. // // SourceUserIdentifier is a required field SourceUserIdentifier *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Input to the MergeDeveloperIdentities action.
func (MergeDeveloperIdentitiesInput) GoString ¶
func (s MergeDeveloperIdentitiesInput) GoString() string
GoString returns the string representation
func (*MergeDeveloperIdentitiesInput) SetDestinationUserIdentifier ¶ added in v1.6.16
func (s *MergeDeveloperIdentitiesInput) SetDestinationUserIdentifier(v string) *MergeDeveloperIdentitiesInput
SetDestinationUserIdentifier sets the DestinationUserIdentifier field's value.
func (*MergeDeveloperIdentitiesInput) SetDeveloperProviderName ¶ added in v1.6.16
func (s *MergeDeveloperIdentitiesInput) SetDeveloperProviderName(v string) *MergeDeveloperIdentitiesInput
SetDeveloperProviderName sets the DeveloperProviderName field's value.
func (*MergeDeveloperIdentitiesInput) SetIdentityPoolId ¶ added in v1.6.16
func (s *MergeDeveloperIdentitiesInput) SetIdentityPoolId(v string) *MergeDeveloperIdentitiesInput
SetIdentityPoolId sets the IdentityPoolId field's value.
func (*MergeDeveloperIdentitiesInput) SetSourceUserIdentifier ¶ added in v1.6.16
func (s *MergeDeveloperIdentitiesInput) SetSourceUserIdentifier(v string) *MergeDeveloperIdentitiesInput
SetSourceUserIdentifier sets the SourceUserIdentifier field's value.
func (MergeDeveloperIdentitiesInput) String ¶
func (s MergeDeveloperIdentitiesInput) String() string
String returns the string representation
func (*MergeDeveloperIdentitiesInput) Validate ¶ added in v1.3.0
func (s *MergeDeveloperIdentitiesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type MergeDeveloperIdentitiesOutput ¶
type MergeDeveloperIdentitiesOutput struct { // A unique identifier in the format REGION:GUID. IdentityId *string `min:"1" type:"string"` // contains filtered or unexported fields }
Returned in response to a successful MergeDeveloperIdentities action.
func (MergeDeveloperIdentitiesOutput) GoString ¶
func (s MergeDeveloperIdentitiesOutput) GoString() string
GoString returns the string representation
func (*MergeDeveloperIdentitiesOutput) SetIdentityId ¶ added in v1.6.16
func (s *MergeDeveloperIdentitiesOutput) SetIdentityId(v string) *MergeDeveloperIdentitiesOutput
SetIdentityId sets the IdentityId field's value.
func (MergeDeveloperIdentitiesOutput) String ¶
func (s MergeDeveloperIdentitiesOutput) String() string
String returns the string representation
type Provider ¶ added in v1.1.19
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.
func (*Provider) SetClientId ¶ added in v1.6.16
SetClientId sets the ClientId field's value.
func (*Provider) SetProviderName ¶ added in v1.6.16
SetProviderName sets the ProviderName field's value.
func (*Provider) SetServerSideTokenCheck ¶ added in v1.7.0
SetServerSideTokenCheck sets the ServerSideTokenCheck field's value.
type RoleMapping ¶ added in v1.6.16
type RoleMapping struct { // If you specify Token or Rules as the Type, AmbiguousRoleResolution is required. // // Specifies the action to be taken if either no rules match the claim value // for the Rules type, or there is no cognito:preferred_role claim and there // are multiple cognito:roles matches for the Token type. AmbiguousRoleResolution *string `type:"string" enum:"AmbiguousRoleResolutionType"` // The rules to be used for mapping users to roles. // // If you specify Rules as the role mapping type, RulesConfiguration is required. RulesConfiguration *RulesConfigurationType `type:"structure"` // The role mapping type. Token will use cognito:roles and cognito:preferred_role // claims from the Cognito identity provider token to map groups to roles. Rules // will attempt to match claims from the token to map to a role. // // Type is a required field Type *string `type:"string" required:"true" enum:"RoleMappingType"` // contains filtered or unexported fields }
A role mapping.
func (RoleMapping) GoString ¶ added in v1.6.16
func (s RoleMapping) GoString() string
GoString returns the string representation
func (*RoleMapping) SetAmbiguousRoleResolution ¶ added in v1.6.16
func (s *RoleMapping) SetAmbiguousRoleResolution(v string) *RoleMapping
SetAmbiguousRoleResolution sets the AmbiguousRoleResolution field's value.
func (*RoleMapping) SetRulesConfiguration ¶ added in v1.6.16
func (s *RoleMapping) SetRulesConfiguration(v *RulesConfigurationType) *RoleMapping
SetRulesConfiguration sets the RulesConfiguration field's value.
func (*RoleMapping) SetType ¶ added in v1.6.16
func (s *RoleMapping) SetType(v string) *RoleMapping
SetType sets the Type field's value.
func (RoleMapping) String ¶ added in v1.6.16
func (s RoleMapping) String() string
String returns the string representation
func (*RoleMapping) Validate ¶ added in v1.6.16
func (s *RoleMapping) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RulesConfigurationType ¶ added in v1.6.16
type RulesConfigurationType struct { // An array of rules. You can specify up to 25 rules per identity provider. // // Rules are evaluated in order. The first one to match specifies the role. // // Rules is a required field Rules []*MappingRule `min:"1" type:"list" required:"true"` // contains filtered or unexported fields }
A container for rules.
func (RulesConfigurationType) GoString ¶ added in v1.6.16
func (s RulesConfigurationType) GoString() string
GoString returns the string representation
func (*RulesConfigurationType) SetRules ¶ added in v1.6.16
func (s *RulesConfigurationType) SetRules(v []*MappingRule) *RulesConfigurationType
SetRules sets the Rules field's value.
func (RulesConfigurationType) String ¶ added in v1.6.16
func (s RulesConfigurationType) String() string
String returns the string representation
func (*RulesConfigurationType) Validate ¶ added in v1.6.16
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.
func (SetIdentityPoolRolesInput) GoString ¶
func (s SetIdentityPoolRolesInput) GoString() string
GoString returns the string representation
func (*SetIdentityPoolRolesInput) SetIdentityPoolId ¶ added in v1.6.16
func (s *SetIdentityPoolRolesInput) SetIdentityPoolId(v string) *SetIdentityPoolRolesInput
SetIdentityPoolId sets the IdentityPoolId field's value.
func (*SetIdentityPoolRolesInput) SetRoleMappings ¶ added in v1.6.16
func (s *SetIdentityPoolRolesInput) SetRoleMappings(v map[string]*RoleMapping) *SetIdentityPoolRolesInput
SetRoleMappings sets the RoleMappings field's value.
func (*SetIdentityPoolRolesInput) SetRoles ¶ added in v1.6.16
func (s *SetIdentityPoolRolesInput) SetRoles(v map[string]*string) *SetIdentityPoolRolesInput
SetRoles sets the Roles field's value.
func (SetIdentityPoolRolesInput) String ¶
func (s SetIdentityPoolRolesInput) String() string
String returns the string representation
func (*SetIdentityPoolRolesInput) Validate ¶ added in v1.3.0
func (s *SetIdentityPoolRolesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SetIdentityPoolRolesOutput ¶
type SetIdentityPoolRolesOutput struct {
// contains filtered or unexported fields
}
func (SetIdentityPoolRolesOutput) GoString ¶
func (s SetIdentityPoolRolesOutput) GoString() string
GoString returns the string representation
func (SetIdentityPoolRolesOutput) String ¶
func (s SetIdentityPoolRolesOutput) String() string
String returns the string representation
type UnlinkDeveloperIdentityInput ¶
type UnlinkDeveloperIdentityInput struct { // The "domain" by which Cognito will refer to your users. // // DeveloperProviderName is a required field DeveloperProviderName *string `min:"1" type:"string" required:"true"` // A unique ID used by your backend authentication process to identify a user. // // DeveloperUserIdentifier is a required field DeveloperUserIdentifier *string `min:"1" type:"string" required:"true"` // A unique identifier in the format REGION:GUID. // // IdentityId is a required field IdentityId *string `min:"1" type:"string" required:"true"` // An identity pool ID in the format REGION:GUID. // // IdentityPoolId is a required field IdentityPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Input to the UnlinkDeveloperIdentity action.
func (UnlinkDeveloperIdentityInput) GoString ¶
func (s UnlinkDeveloperIdentityInput) GoString() string
GoString returns the string representation
func (*UnlinkDeveloperIdentityInput) SetDeveloperProviderName ¶ added in v1.6.16
func (s *UnlinkDeveloperIdentityInput) SetDeveloperProviderName(v string) *UnlinkDeveloperIdentityInput
SetDeveloperProviderName sets the DeveloperProviderName field's value.
func (*UnlinkDeveloperIdentityInput) SetDeveloperUserIdentifier ¶ added in v1.6.16
func (s *UnlinkDeveloperIdentityInput) SetDeveloperUserIdentifier(v string) *UnlinkDeveloperIdentityInput
SetDeveloperUserIdentifier sets the DeveloperUserIdentifier field's value.
func (*UnlinkDeveloperIdentityInput) SetIdentityId ¶ added in v1.6.16
func (s *UnlinkDeveloperIdentityInput) SetIdentityId(v string) *UnlinkDeveloperIdentityInput
SetIdentityId sets the IdentityId field's value.
func (*UnlinkDeveloperIdentityInput) SetIdentityPoolId ¶ added in v1.6.16
func (s *UnlinkDeveloperIdentityInput) SetIdentityPoolId(v string) *UnlinkDeveloperIdentityInput
SetIdentityPoolId sets the IdentityPoolId field's value.
func (UnlinkDeveloperIdentityInput) String ¶
func (s UnlinkDeveloperIdentityInput) String() string
String returns the string representation
func (*UnlinkDeveloperIdentityInput) Validate ¶ added in v1.3.0
func (s *UnlinkDeveloperIdentityInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UnlinkDeveloperIdentityOutput ¶
type UnlinkDeveloperIdentityOutput struct {
// contains filtered or unexported fields
}
func (UnlinkDeveloperIdentityOutput) GoString ¶
func (s UnlinkDeveloperIdentityOutput) GoString() string
GoString returns the string representation
func (UnlinkDeveloperIdentityOutput) String ¶
func (s UnlinkDeveloperIdentityOutput) String() string
String returns the string representation
type UnlinkIdentityInput ¶
type UnlinkIdentityInput struct { // A unique identifier in the format REGION:GUID. // // IdentityId is a required field IdentityId *string `min:"1" type:"string" required:"true"` // A set of optional name-value pairs that map provider names to provider tokens. // // Logins is a required field Logins map[string]*string `type:"map" required:"true"` // Provider names to unlink from this identity. // // LoginsToRemove is a required field LoginsToRemove []*string `type:"list" required:"true"` // contains filtered or unexported fields }
Input to the UnlinkIdentity action.
func (UnlinkIdentityInput) GoString ¶
func (s UnlinkIdentityInput) GoString() string
GoString returns the string representation
func (*UnlinkIdentityInput) SetIdentityId ¶ added in v1.6.16
func (s *UnlinkIdentityInput) SetIdentityId(v string) *UnlinkIdentityInput
SetIdentityId sets the IdentityId field's value.
func (*UnlinkIdentityInput) SetLogins ¶ added in v1.6.16
func (s *UnlinkIdentityInput) SetLogins(v map[string]*string) *UnlinkIdentityInput
SetLogins sets the Logins field's value.
func (*UnlinkIdentityInput) SetLoginsToRemove ¶ added in v1.6.16
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 ¶ added in v1.3.0
func (s *UnlinkIdentityInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UnlinkIdentityOutput ¶
type UnlinkIdentityOutput struct {
// contains filtered or unexported fields
}
func (UnlinkIdentityOutput) GoString ¶
func (s UnlinkIdentityOutput) GoString() string
GoString returns the string representation
func (UnlinkIdentityOutput) String ¶
func (s UnlinkIdentityOutput) String() string
String returns the string representation
type UnprocessedIdentityId ¶
type UnprocessedIdentityId struct { // The error code indicating the type of error that occurred. ErrorCode *string `type:"string" enum:"ErrorCode"` // A unique identifier in the format REGION:GUID. IdentityId *string `min:"1" type:"string"` // contains filtered or unexported fields }
An array of UnprocessedIdentityId objects, each of which contains an ErrorCode and IdentityId.
func (UnprocessedIdentityId) GoString ¶
func (s UnprocessedIdentityId) GoString() string
GoString returns the string representation
func (*UnprocessedIdentityId) SetErrorCode ¶ added in v1.6.16
func (s *UnprocessedIdentityId) SetErrorCode(v string) *UnprocessedIdentityId
SetErrorCode sets the ErrorCode field's value.
func (*UnprocessedIdentityId) SetIdentityId ¶ added in v1.6.16
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
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. |