111 lines
5.4 KiB
Go
111 lines
5.4 KiB
Go
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
|
|
|
|
// 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 use the client for Amazon Cognito Identity you will first need
|
|
// to create a new instance of it.
|
|
//
|
|
// When creating a client for an AWS service you'll first need to have a Session
|
|
// already created. The Session provides configuration that can be shared
|
|
// between multiple service clients. Additional configuration can be applied to
|
|
// the Session and service's client when they are constructed. The aws package's
|
|
// Config type contains several fields such as Region for the AWS Region the
|
|
// client should make API requests too. The optional Config value can be provided
|
|
// as the variadic argument for Sessions and client creation.
|
|
//
|
|
// Once the service's client is created you can use it to make API requests the
|
|
// AWS service. These clients are safe to use concurrently.
|
|
//
|
|
// // Create a session to share configuration, and load external configuration.
|
|
// sess := session.Must(session.NewSession())
|
|
//
|
|
// // Create the service's client with the session.
|
|
// svc := cognitoidentity.New(sess)
|
|
//
|
|
// See the SDK's documentation for more information on how to use service clients.
|
|
// https://docs.aws.amazon.com/sdk-for-go/api/
|
|
//
|
|
// See aws package's Config type for more information on configuration options.
|
|
// https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
|
|
//
|
|
// See the Amazon Cognito Identity client CognitoIdentity for more
|
|
// information on creating the service's client.
|
|
// https://docs.aws.amazon.com/sdk-for-go/api/service/cognitoidentity/#New
|
|
//
|
|
// Once the client is created you can make an API request to the service.
|
|
// Each API method takes a input parameter, and returns the service response
|
|
// and an error.
|
|
//
|
|
// The API method will document which error codes the service can be returned
|
|
// by the operation if the service models the API operation's errors. These
|
|
// errors will also be available as const strings prefixed with "ErrCode".
|
|
//
|
|
// result, err := svc.CreateIdentityPool(params)
|
|
// if err != nil {
|
|
// // Cast err to awserr.Error to handle specific error codes.
|
|
// aerr, ok := err.(awserr.Error)
|
|
// if ok && aerr.Code() == <error code to check for> {
|
|
// // Specific error code handling
|
|
// }
|
|
// return err
|
|
// }
|
|
//
|
|
// fmt.Println("CreateIdentityPool result:")
|
|
// fmt.Println(result)
|
|
//
|
|
// Using the Client with Context
|
|
//
|
|
// The service's client also provides methods to make API requests with a Context
|
|
// value. This allows you to control the timeout, and cancellation of pending
|
|
// requests. These methods also take request Option as variadic parameter to apply
|
|
// additional configuration to the API request.
|
|
//
|
|
// ctx := context.Background()
|
|
//
|
|
// result, err := svc.CreateIdentityPoolWithContext(ctx, params)
|
|
//
|
|
// See the request package documentation for more information on using Context pattern
|
|
// with the SDK.
|
|
// https://docs.aws.amazon.com/sdk-for-go/api/aws/request/
|
|
package cognitoidentity
|