openapi: 3.2.0 info: version: '2014-06-30' x-release: v4 title: Amazon Cognito Identity API description: 'Amazon Cognito Federated Identities Amazon Cognito Federated Identities is a web service that delivers scoped temporary credentials to mobile devices and other untrusted environments.' x-logo: url: https://twitter.com/awscloud/profile_image?size=original backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: cognito-identity x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/cognito-identity-2014-06-30.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://cognito-identity.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon Cognito Identity multi-region endpoint - url: https://cognito-identity.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon Cognito Identity multi-region endpoint - url: http://cognito-identity.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon Cognito Identity endpoint for China (Beijing) and China (Ningxia) - url: https://cognito-identity.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon Cognito Identity endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: Amazon Cognito Identity paths: /#X-Amz-Target=AWSCognitoIdentityService.CreateIdentityPool: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateIdentityPool description: 'Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account. The keys for SupportedLoginProviders are as follows: Facebook: graph.facebook.com Google: accounts.google.com Amazon: www.amazon.com Twitter: api.twitter.com Digits: www.digits.com You must use AWS Developer credentials to call this API.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/IdentityPool' examples: CreateIdentityPool200Example: summary: Default CreateIdentityPool 200 response x-microcks-default: true value: IdentityPoolId: example IdentityPoolName: example AllowUnauthenticatedIdentities: example AllowClassicFlow: example SupportedLoginProviders: example DeveloperProviderName: example OpenIdConnectProviderARNs: example CognitoIdentityProviders: example SamlProviderARNs: example IdentityPoolTags: example '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' examples: CreateIdentityPool480Example: summary: Default CreateIdentityPool 480 response x-microcks-default: true value: example '481': description: NotAuthorizedException content: application/json: schema: $ref: '#/components/schemas/NotAuthorizedException' examples: CreateIdentityPool481Example: summary: Default CreateIdentityPool 481 response x-microcks-default: true value: example '482': description: ResourceConflictException content: application/json: schema: $ref: '#/components/schemas/ResourceConflictException' examples: CreateIdentityPool482Example: summary: Default CreateIdentityPool 482 response x-microcks-default: true value: example '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: CreateIdentityPool483Example: summary: Default CreateIdentityPool 483 response x-microcks-default: true value: example '484': description: InternalErrorException content: application/json: schema: $ref: '#/components/schemas/InternalErrorException' examples: CreateIdentityPool484Example: summary: Default CreateIdentityPool 484 response x-microcks-default: true value: example '485': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' examples: CreateIdentityPool485Example: summary: Default CreateIdentityPool 485 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateIdentityPoolInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityService.CreateIdentityPool summary: Amazon Cognito Create Identity Pool x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Cognito Identity /#X-Amz-Target=AWSCognitoIdentityService.DeleteIdentities: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: DeleteIdentities description: '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.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteIdentitiesResponse' examples: DeleteIdentities200Example: summary: Default DeleteIdentities 200 response x-microcks-default: true value: UnprocessedIdentityIds: example '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' examples: DeleteIdentities480Example: summary: Default DeleteIdentities 480 response x-microcks-default: true value: example '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: DeleteIdentities481Example: summary: Default DeleteIdentities 481 response x-microcks-default: true value: example '482': description: InternalErrorException content: application/json: schema: $ref: '#/components/schemas/InternalErrorException' examples: DeleteIdentities482Example: summary: Default DeleteIdentities 482 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteIdentitiesInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityService.DeleteIdentities summary: Amazon Cognito Delete Identities x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Cognito Identity /#X-Amz-Target=AWSCognitoIdentityService.DeleteIdentityPool: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: DeleteIdentityPool description: 'Deletes an identity pool. Once a pool is deleted, users will not be able to authenticate with the pool. You must use AWS Developer credentials to call this API.' responses: '200': description: Success '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' examples: DeleteIdentityPool480Example: summary: Default DeleteIdentityPool 480 response x-microcks-default: true value: example '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: DeleteIdentityPool481Example: summary: Default DeleteIdentityPool 481 response x-microcks-default: true value: example '482': description: NotAuthorizedException content: application/json: schema: $ref: '#/components/schemas/NotAuthorizedException' examples: DeleteIdentityPool482Example: summary: Default DeleteIdentityPool 482 response x-microcks-default: true value: example '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: DeleteIdentityPool483Example: summary: Default DeleteIdentityPool 483 response x-microcks-default: true value: example '484': description: InternalErrorException content: application/json: schema: $ref: '#/components/schemas/InternalErrorException' examples: DeleteIdentityPool484Example: summary: Default DeleteIdentityPool 484 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteIdentityPoolInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityService.DeleteIdentityPool summary: Amazon Cognito Delete Identity Pool x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Cognito Identity /#X-Amz-Target=AWSCognitoIdentityService.DescribeIdentity: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: DescribeIdentity description: '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.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/IdentityDescription' examples: DescribeIdentity200Example: summary: Default DescribeIdentity 200 response x-microcks-default: true value: IdentityId: example Logins: example CreationDate: example LastModifiedDate: example '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' examples: DescribeIdentity480Example: summary: Default DescribeIdentity 480 response x-microcks-default: true value: example '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: DescribeIdentity481Example: summary: Default DescribeIdentity 481 response x-microcks-default: true value: example '482': description: NotAuthorizedException content: application/json: schema: $ref: '#/components/schemas/NotAuthorizedException' examples: DescribeIdentity482Example: summary: Default DescribeIdentity 482 response x-microcks-default: true value: example '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: DescribeIdentity483Example: summary: Default DescribeIdentity 483 response x-microcks-default: true value: example '484': description: InternalErrorException content: application/json: schema: $ref: '#/components/schemas/InternalErrorException' examples: DescribeIdentity484Example: summary: Default DescribeIdentity 484 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeIdentityInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityService.DescribeIdentity summary: Amazon Cognito Describe Identity x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Cognito Identity /#X-Amz-Target=AWSCognitoIdentityService.DescribeIdentityPool: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: DescribeIdentityPool description: '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.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/IdentityPool' examples: DescribeIdentityPool200Example: summary: Default DescribeIdentityPool 200 response x-microcks-default: true value: IdentityPoolId: example IdentityPoolName: example AllowUnauthenticatedIdentities: example AllowClassicFlow: example SupportedLoginProviders: example DeveloperProviderName: example OpenIdConnectProviderARNs: example CognitoIdentityProviders: example SamlProviderARNs: example IdentityPoolTags: example '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' examples: DescribeIdentityPool480Example: summary: Default DescribeIdentityPool 480 response x-microcks-default: true value: example '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: DescribeIdentityPool481Example: summary: Default DescribeIdentityPool 481 response x-microcks-default: true value: example '482': description: NotAuthorizedException content: application/json: schema: $ref: '#/components/schemas/NotAuthorizedException' examples: DescribeIdentityPool482Example: summary: Default DescribeIdentityPool 482 response x-microcks-default: true value: example '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: DescribeIdentityPool483Example: summary: Default DescribeIdentityPool 483 response x-microcks-default: true value: example '484': description: InternalErrorException content: application/json: schema: $ref: '#/components/schemas/InternalErrorException' examples: DescribeIdentityPool484Example: summary: Default DescribeIdentityPool 484 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeIdentityPoolInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityService.DescribeIdentityPool summary: Amazon Cognito Describe Identity Pool x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Cognito Identity /#X-Amz-Target=AWSCognitoIdentityService.GetCredentialsForIdentity: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: GetCredentialsForIdentity description: '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.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetCredentialsForIdentityResponse' examples: GetCredentialsForIdentity200Example: summary: Default GetCredentialsForIdentity 200 response x-microcks-default: true value: IdentityId: example Credentials: example '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' examples: GetCredentialsForIdentity480Example: summary: Default GetCredentialsForIdentity 480 response x-microcks-default: true value: example '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: GetCredentialsForIdentity481Example: summary: Default GetCredentialsForIdentity 481 response x-microcks-default: true value: example '482': description: NotAuthorizedException content: application/json: schema: $ref: '#/components/schemas/NotAuthorizedException' examples: GetCredentialsForIdentity482Example: summary: Default GetCredentialsForIdentity 482 response x-microcks-default: true value: example '483': description: ResourceConflictException content: application/json: schema: $ref: '#/components/schemas/ResourceConflictException' examples: GetCredentialsForIdentity483Example: summary: Default GetCredentialsForIdentity 483 response x-microcks-default: true value: example '484': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: GetCredentialsForIdentity484Example: summary: Default GetCredentialsForIdentity 484 response x-microcks-default: true value: example '485': description: InvalidIdentityPoolConfigurationException content: application/json: schema: $ref: '#/components/schemas/InvalidIdentityPoolConfigurationException' examples: GetCredentialsForIdentity485Example: summary: Default GetCredentialsForIdentity 485 response x-microcks-default: true value: example '486': description: InternalErrorException content: application/json: schema: $ref: '#/components/schemas/InternalErrorException' examples: GetCredentialsForIdentity486Example: summary: Default GetCredentialsForIdentity 486 response x-microcks-default: true value: example '487': description: ExternalServiceException content: application/json: schema: $ref: '#/components/schemas/ExternalServiceException' examples: GetCredentialsForIdentity487Example: summary: Default GetCredentialsForIdentity 487 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetCredentialsForIdentityInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityService.GetCredentialsForIdentity summary: Amazon Cognito Get Credentials for Identity x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Cognito Identity /#X-Amz-Target=AWSCognitoIdentityService.GetId: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: GetId description: '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.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetIdResponse' examples: GetId200Example: summary: Default GetId 200 response x-microcks-default: true value: IdentityId: example '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' examples: GetId480Example: summary: Default GetId 480 response x-microcks-default: true value: example '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: GetId481Example: summary: Default GetId 481 response x-microcks-default: true value: example '482': description: NotAuthorizedException content: application/json: schema: $ref: '#/components/schemas/NotAuthorizedException' examples: GetId482Example: summary: Default GetId 482 response x-microcks-default: true value: example '483': description: ResourceConflictException content: application/json: schema: $ref: '#/components/schemas/ResourceConflictException' examples: GetId483Example: summary: Default GetId 483 response x-microcks-default: true value: example '484': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: GetId484Example: summary: Default GetId 484 response x-microcks-default: true value: example '485': description: InternalErrorException content: application/json: schema: $ref: '#/components/schemas/InternalErrorException' examples: GetId485Example: summary: Default GetId 485 response x-microcks-default: true value: example '486': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' examples: GetId486Example: summary: Default GetId 486 response x-microcks-default: true value: example '487': description: ExternalServiceException content: application/json: schema: $ref: '#/components/schemas/ExternalServiceException' examples: GetId487Example: summary: Default GetId 487 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetIdInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityService.GetId summary: Amazon Cognito Get Id x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Cognito Identity /#X-Amz-Target=AWSCognitoIdentityService.GetIdentityPoolRoles: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: GetIdentityPoolRoles description: 'Gets the roles for an identity pool. You must use AWS Developer credentials to call this API.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetIdentityPoolRolesResponse' examples: GetIdentityPoolRoles200Example: summary: Default GetIdentityPoolRoles 200 response x-microcks-default: true value: IdentityPoolId: example Roles: example RoleMappings: example '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' examples: GetIdentityPoolRoles480Example: summary: Default GetIdentityPoolRoles 480 response x-microcks-default: true value: example '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: GetIdentityPoolRoles481Example: summary: Default GetIdentityPoolRoles 481 response x-microcks-default: true value: example '482': description: NotAuthorizedException content: application/json: schema: $ref: '#/components/schemas/NotAuthorizedException' examples: GetIdentityPoolRoles482Example: summary: Default GetIdentityPoolRoles 482 response x-microcks-default: true value: example '483': description: ResourceConflictException content: application/json: schema: $ref: '#/components/schemas/ResourceConflictException' examples: GetIdentityPoolRoles483Example: summary: Default GetIdentityPoolRoles 483 response x-microcks-default: true value: example '484': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: GetIdentityPoolRoles484Example: summary: Default GetIdentityPoolRoles 484 response x-microcks-default: true value: example '485': description: InternalErrorException content: application/json: schema: $ref: '#/components/schemas/InternalErrorException' examples: GetIdentityPoolRoles485Example: summary: Default GetIdentityPoolRoles 485 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetIdentityPoolRolesInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityService.GetIdentityPoolRoles summary: Amazon Cognito Get Identity Pool Roles x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Cognito Identity /#X-Amz-Target=AWSCognitoIdentityService.GetOpenIdToken: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: GetOpenIdToken description: 'Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by GetId. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link. The OpenID token is valid for 10 minutes. This is a public API. You do not need any credentials to call this API.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetOpenIdTokenResponse' examples: GetOpenIdToken200Example: summary: Default GetOpenIdToken 200 response x-microcks-default: true value: IdentityId: example Token: example '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' examples: GetOpenIdToken480Example: summary: Default GetOpenIdToken 480 response x-microcks-default: true value: example '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: GetOpenIdToken481Example: summary: Default GetOpenIdToken 481 response x-microcks-default: true value: example '482': description: NotAuthorizedException content: application/json: schema: $ref: '#/components/schemas/NotAuthorizedException' examples: GetOpenIdToken482Example: summary: Default GetOpenIdToken 482 response x-microcks-default: true value: example '483': description: ResourceConflictException content: application/json: schema: $ref: '#/components/schemas/ResourceConflictException' examples: GetOpenIdToken483Example: summary: Default GetOpenIdToken 483 response x-microcks-default: true value: example '484': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: GetOpenIdToken484Example: summary: Default GetOpenIdToken 484 response x-microcks-default: true value: example '485': description: InternalErrorException content: application/json: schema: $ref: '#/components/schemas/InternalErrorException' examples: GetOpenIdToken485Example: summary: Default GetOpenIdToken 485 response x-microcks-default: true value: example '486': description: ExternalServiceException content: application/json: schema: $ref: '#/components/schemas/ExternalServiceException' examples: GetOpenIdToken486Example: summary: Default GetOpenIdToken 486 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetOpenIdTokenInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityService.GetOpenIdToken summary: Amazon Cognito Get Open Id Token x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Cognito Identity /#X-Amz-Target=AWSCognitoIdentityService.GetOpenIdTokenForDeveloperIdentity: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: GetOpenIdTokenForDeveloperIdentity description: '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.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetOpenIdTokenForDeveloperIdentityResponse' examples: GetOpenIdTokenForDeveloperIdentity200Example: summary: Default GetOpenIdTokenForDeveloperIdentity 200 response x-microcks-default: true value: IdentityId: example Token: example '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' examples: GetOpenIdTokenForDeveloperIdentity480Example: summary: Default GetOpenIdTokenForDeveloperIdentity 480 response x-microcks-default: true value: example '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: GetOpenIdTokenForDeveloperIdentity481Example: summary: Default GetOpenIdTokenForDeveloperIdentity 481 response x-microcks-default: true value: example '482': description: NotAuthorizedException content: application/json: schema: $ref: '#/components/schemas/NotAuthorizedException' examples: GetOpenIdTokenForDeveloperIdentity482Example: summary: Default GetOpenIdTokenForDeveloperIdentity 482 response x-microcks-default: true value: example '483': description: ResourceConflictException content: application/json: schema: $ref: '#/components/schemas/ResourceConflictException' examples: GetOpenIdTokenForDeveloperIdentity483Example: summary: Default GetOpenIdTokenForDeveloperIdentity 483 response x-microcks-default: true value: example '484': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: GetOpenIdTokenForDeveloperIdentity484Example: summary: Default GetOpenIdTokenForDeveloperIdentity 484 response x-microcks-default: true value: example '485': description: InternalErrorException content: application/json: schema: $ref: '#/components/schemas/InternalErrorException' examples: GetOpenIdTokenForDeveloperIdentity485Example: summary: Default GetOpenIdTokenForDeveloperIdentity 485 response x-microcks-default: true value: example '486': description: DeveloperUserAlreadyRegisteredException content: application/json: schema: $ref: '#/components/schemas/DeveloperUserAlreadyRegisteredException' examples: GetOpenIdTokenForDeveloperIdentity486Example: summary: Default GetOpenIdTokenForDeveloperIdentity 486 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetOpenIdTokenForDeveloperIdentityInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityService.GetOpenIdTokenForDeveloperIdentity summary: Amazon Cognito Get Open Id Token for Developer Identity x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Cognito Identity /#X-Amz-Target=AWSCognitoIdentityService.GetPrincipalTagAttributeMap: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: GetPrincipalTagAttributeMap description: Use GetPrincipalTagAttributeMap to list all mappings between PrincipalTags and user attributes. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetPrincipalTagAttributeMapResponse' examples: GetPrincipalTagAttributeMap200Example: summary: Default GetPrincipalTagAttributeMap 200 response x-microcks-default: true value: IdentityPoolId: example IdentityProviderName: example UseDefaults: example PrincipalTags: example '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' examples: GetPrincipalTagAttributeMap480Example: summary: Default GetPrincipalTagAttributeMap 480 response x-microcks-default: true value: example '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: GetPrincipalTagAttributeMap481Example: summary: Default GetPrincipalTagAttributeMap 481 response x-microcks-default: true value: example '482': description: NotAuthorizedException content: application/json: schema: $ref: '#/components/schemas/NotAuthorizedException' examples: GetPrincipalTagAttributeMap482Example: summary: Default GetPrincipalTagAttributeMap 482 response x-microcks-default: true value: example '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: GetPrincipalTagAttributeMap483Example: summary: Default GetPrincipalTagAttributeMap 483 response x-microcks-default: true value: example '484': description: InternalErrorException content: application/json: schema: $ref: '#/components/schemas/InternalErrorException' examples: GetPrincipalTagAttributeMap484Example: summary: Default GetPrincipalTagAttributeMap 484 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetPrincipalTagAttributeMapInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityService.GetPrincipalTagAttributeMap summary: Amazon Cognito Get Principal Tag Attribute Map x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Cognito Identity /#X-Amz-Target=AWSCognitoIdentityService.ListIdentities: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ListIdentities description: 'Lists the identities in an identity pool. You must use AWS Developer credentials to call this API.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListIdentitiesResponse' examples: ListIdentities200Example: summary: Default ListIdentities 200 response x-microcks-default: true value: IdentityPoolId: example Identities: example NextToken: example '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' examples: ListIdentities480Example: summary: Default ListIdentities 480 response x-microcks-default: true value: example '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: ListIdentities481Example: summary: Default ListIdentities 481 response x-microcks-default: true value: example '482': description: NotAuthorizedException content: application/json: schema: $ref: '#/components/schemas/NotAuthorizedException' examples: ListIdentities482Example: summary: Default ListIdentities 482 response x-microcks-default: true value: example '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: ListIdentities483Example: summary: Default ListIdentities 483 response x-microcks-default: true value: example '484': description: InternalErrorException content: application/json: schema: $ref: '#/components/schemas/InternalErrorException' examples: ListIdentities484Example: summary: Default ListIdentities 484 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListIdentitiesInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityService.ListIdentities summary: Amazon Cognito List Identities x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Cognito Identity /#X-Amz-Target=AWSCognitoIdentityService.ListIdentityPools: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ListIdentityPools description: 'Lists all of the Cognito identity pools registered for your account. You must use AWS Developer credentials to call this API.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListIdentityPoolsResponse' examples: ListIdentityPools200Example: summary: Default ListIdentityPools 200 response x-microcks-default: true value: IdentityPools: example NextToken: example '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' examples: ListIdentityPools480Example: summary: Default ListIdentityPools 480 response x-microcks-default: true value: example '481': description: NotAuthorizedException content: application/json: schema: $ref: '#/components/schemas/NotAuthorizedException' examples: ListIdentityPools481Example: summary: Default ListIdentityPools 481 response x-microcks-default: true value: example '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: ListIdentityPools482Example: summary: Default ListIdentityPools 482 response x-microcks-default: true value: example '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: ListIdentityPools483Example: summary: Default ListIdentityPools 483 response x-microcks-default: true value: example '484': description: InternalErrorException content: application/json: schema: $ref: '#/components/schemas/InternalErrorException' examples: ListIdentityPools484Example: summary: Default ListIdentityPools 484 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListIdentityPoolsInput' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityService.ListIdentityPools summary: Amazon Cognito List Identity Pools x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Cognito Identity /#X-Amz-Target=AWSCognitoIdentityService.ListTagsForResource: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ListTagsForResource description: 'Lists the tags that are assigned to an Amazon Cognito identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria. You can use this action up to 10 times per second, per account.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListTagsForResourceResponse' examples: ListTagsForResource200Example: summary: Default ListTagsForResource 200 response x-microcks-default: true value: Tags: example '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' examples: ListTagsForResource480Example: summary: Default ListTagsForResource 480 response x-microcks-default: true value: example '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: ListTagsForResource481Example: summary: Default ListTagsForResource 481 response x-microcks-default: true value: example '482': description: NotAuthorizedException content: application/json: schema: $ref: '#/components/schemas/NotAuthorizedException' examples: ListTagsForResource482Example: summary: Default ListTagsForResource 482 response x-microcks-default: true value: example '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: ListTagsForResource483Example: summary: Default ListTagsForResource 483 response x-microcks-default: true value: example '484': description: InternalErrorException content: application/json: schema: $ref: '#/components/schemas/InternalErrorException' examples: ListTagsForResource484Example: summary: Default ListTagsForResource 484 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListTagsForResourceInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityService.ListTagsForResource summary: Amazon Cognito List Tags for Resource x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Cognito Identity /#X-Amz-Target=AWSCognitoIdentityService.LookupDeveloperIdentity: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: LookupDeveloperIdentity description: 'Retrieves the IdentityID associated with a DeveloperUserIdentifier or the list of DeveloperUserIdentifier values associated with an IdentityId for an existing identity. Either IdentityID or DeveloperUserIdentifier must not be null. If you supply only one of these values, the other value will be searched in the database and returned as a part of the response. If you supply both, DeveloperUserIdentifier will be matched against IdentityID. If the values are verified against the database, the response returns both values and is the same as the request. Otherwise a ResourceConflictException is thrown. LookupDeveloperIdentity is intended for low-throughput control plane operations: for example, to enable customer service to locate an identity ID by username. If you are using it for higher-volume operations such as user authentication, your requests are likely to be throttled. GetOpenIdTokenForDeveloperIdentity is a better option for higher-volume operations for user authentication. You must use AWS Developer credentials to call this API.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/LookupDeveloperIdentityResponse' examples: LookupDeveloperIdentity200Example: summary: Default LookupDeveloperIdentity 200 response x-microcks-default: true value: IdentityId: example DeveloperUserIdentifierList: example NextToken: example '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' examples: LookupDeveloperIdentity480Example: summary: Default LookupDeveloperIdentity 480 response x-microcks-default: true value: example '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: LookupDeveloperIdentity481Example: summary: Default LookupDeveloperIdentity 481 response x-microcks-default: true value: example '482': description: NotAuthorizedException content: application/json: schema: $ref: '#/components/schemas/NotAuthorizedException' examples: LookupDeveloperIdentity482Example: summary: Default LookupDeveloperIdentity 482 response x-microcks-default: true value: example '483': description: ResourceConflictException content: application/json: schema: $ref: '#/components/schemas/ResourceConflictException' examples: LookupDeveloperIdentity483Example: summary: Default LookupDeveloperIdentity 483 response x-microcks-default: true value: example '484': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: LookupDeveloperIdentity484Example: summary: Default LookupDeveloperIdentity 484 response x-microcks-default: true value: example '485': description: InternalErrorException content: application/json: schema: $ref: '#/components/schemas/InternalErrorException' examples: LookupDeveloperIdentity485Example: summary: Default LookupDeveloperIdentity 485 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/LookupDeveloperIdentityInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityService.LookupDeveloperIdentity summary: Amazon Cognito Lookup Developer Identity x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Cognito Identity /#X-Amz-Target=AWSCognitoIdentityService.MergeDeveloperIdentities: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: MergeDeveloperIdentities description: 'Merges two users having different IdentityIds, existing in the same identity pool, and identified by the same developer provider. You can use this action to request that discrete users be merged and identified as a single user in the Cognito environment. Cognito associates the given source user (SourceUserIdentifier) with the IdentityId of the DestinationUserIdentifier. Only developer-authenticated users can be merged. If the users to be merged are associated with the same public provider, but as two different users, an exception will be thrown. The number of linked logins is limited to 20. So, the number of linked logins for the source user, SourceUserIdentifier, and the destination user, DestinationUserIdentifier, together should not be larger than 20. Otherwise, an exception will be thrown. You must use AWS Developer credentials to call this API.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/MergeDeveloperIdentitiesResponse' examples: MergeDeveloperIdentities200Example: summary: Default MergeDeveloperIdentities 200 response x-microcks-default: true value: IdentityId: example '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' examples: MergeDeveloperIdentities480Example: summary: Default MergeDeveloperIdentities 480 response x-microcks-default: true value: example '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: MergeDeveloperIdentities481Example: summary: Default MergeDeveloperIdentities 481 response x-microcks-default: true value: example '482': description: NotAuthorizedException content: application/json: schema: $ref: '#/components/schemas/NotAuthorizedException' examples: MergeDeveloperIdentities482Example: summary: Default MergeDeveloperIdentities 482 response x-microcks-default: true value: example '483': description: ResourceConflictException content: application/json: schema: $ref: '#/components/schemas/ResourceConflictException' examples: MergeDeveloperIdentities483Example: summary: Default MergeDeveloperIdentities 483 response x-microcks-default: true value: example '484': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: MergeDeveloperIdentities484Example: summary: Default MergeDeveloperIdentities 484 response x-microcks-default: true value: example '485': description: InternalErrorException content: application/json: schema: $ref: '#/components/schemas/InternalErrorException' examples: MergeDeveloperIdentities485Example: summary: Default MergeDeveloperIdentities 485 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/MergeDeveloperIdentitiesInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityService.MergeDeveloperIdentities summary: Amazon Cognito Merge Developer Identities x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Cognito Identity /#X-Amz-Target=AWSCognitoIdentityService.SetIdentityPoolRoles: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: SetIdentityPoolRoles description: '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.' responses: '200': description: Success '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' examples: SetIdentityPoolRoles480Example: summary: Default SetIdentityPoolRoles 480 response x-microcks-default: true value: example '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: SetIdentityPoolRoles481Example: summary: Default SetIdentityPoolRoles 481 response x-microcks-default: true value: example '482': description: NotAuthorizedException content: application/json: schema: $ref: '#/components/schemas/NotAuthorizedException' examples: SetIdentityPoolRoles482Example: summary: Default SetIdentityPoolRoles 482 response x-microcks-default: true value: example '483': description: ResourceConflictException content: application/json: schema: $ref: '#/components/schemas/ResourceConflictException' examples: SetIdentityPoolRoles483Example: summary: Default SetIdentityPoolRoles 483 response x-microcks-default: true value: example '484': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: SetIdentityPoolRoles484Example: summary: Default SetIdentityPoolRoles 484 response x-microcks-default: true value: example '485': description: InternalErrorException content: application/json: schema: $ref: '#/components/schemas/InternalErrorException' examples: SetIdentityPoolRoles485Example: summary: Default SetIdentityPoolRoles 485 response x-microcks-default: true value: example '486': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' examples: SetIdentityPoolRoles486Example: summary: Default SetIdentityPoolRoles 486 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SetIdentityPoolRolesInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityService.SetIdentityPoolRoles summary: Amazon Cognito Set Identity Pool Roles x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Cognito Identity /#X-Amz-Target=AWSCognitoIdentityService.SetPrincipalTagAttributeMap: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: SetPrincipalTagAttributeMap description: You can use this operation to use default (username and clientID) attribute or custom attribute mappings. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/SetPrincipalTagAttributeMapResponse' examples: SetPrincipalTagAttributeMap200Example: summary: Default SetPrincipalTagAttributeMap 200 response x-microcks-default: true value: IdentityPoolId: example IdentityProviderName: example UseDefaults: example PrincipalTags: example '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' examples: SetPrincipalTagAttributeMap480Example: summary: Default SetPrincipalTagAttributeMap 480 response x-microcks-default: true value: example '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: SetPrincipalTagAttributeMap481Example: summary: Default SetPrincipalTagAttributeMap 481 response x-microcks-default: true value: example '482': description: NotAuthorizedException content: application/json: schema: $ref: '#/components/schemas/NotAuthorizedException' examples: SetPrincipalTagAttributeMap482Example: summary: Default SetPrincipalTagAttributeMap 482 response x-microcks-default: true value: example '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: SetPrincipalTagAttributeMap483Example: summary: Default SetPrincipalTagAttributeMap 483 response x-microcks-default: true value: example '484': description: InternalErrorException content: application/json: schema: $ref: '#/components/schemas/InternalErrorException' examples: SetPrincipalTagAttributeMap484Example: summary: Default SetPrincipalTagAttributeMap 484 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SetPrincipalTagAttributeMapInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityService.SetPrincipalTagAttributeMap summary: Amazon Cognito Set Principal Tag Attribute Map x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Cognito Identity /#X-Amz-Target=AWSCognitoIdentityService.TagResource: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: TagResource description: 'Assigns a set of tags to the specified Amazon Cognito identity pool. A tag is a label that you can use to categorize and manage identity pools in different ways, such as by purpose, owner, environment, or other criteria. Each tag consists of a key and value, both of which you define. A key is a general category for more specific values. For example, if you have two versions of an identity pool, one for testing and another for production, you might assign an Environment tag key to both identity pools. The value of this key might be Test for one identity pool and Production for the other. Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your identity pools. In an IAM policy, you can constrain permissions for identity pools based on specific tags or tag values. You can use this action up to 5 times per second, per account. An identity pool can have as many as 50 tags.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/TagResourceResponse' examples: TagResource200Example: summary: Default TagResource 200 response x-microcks-default: true value: {} '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' examples: TagResource480Example: summary: Default TagResource 480 response x-microcks-default: true value: example '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: TagResource481Example: summary: Default TagResource 481 response x-microcks-default: true value: example '482': description: NotAuthorizedException content: application/json: schema: $ref: '#/components/schemas/NotAuthorizedException' examples: TagResource482Example: summary: Default TagResource 482 response x-microcks-default: true value: example '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: TagResource483Example: summary: Default TagResource 483 response x-microcks-default: true value: example '484': description: InternalErrorException content: application/json: schema: $ref: '#/components/schemas/InternalErrorException' examples: TagResource484Example: summary: Default TagResource 484 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TagResourceInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityService.TagResource summary: Amazon Cognito Tag Resource x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Cognito Identity /#X-Amz-Target=AWSCognitoIdentityService.UnlinkDeveloperIdentity: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: UnlinkDeveloperIdentity description: '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.' responses: '200': description: Success '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' examples: UnlinkDeveloperIdentity480Example: summary: Default UnlinkDeveloperIdentity 480 response x-microcks-default: true value: example '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: UnlinkDeveloperIdentity481Example: summary: Default UnlinkDeveloperIdentity 481 response x-microcks-default: true value: example '482': description: NotAuthorizedException content: application/json: schema: $ref: '#/components/schemas/NotAuthorizedException' examples: UnlinkDeveloperIdentity482Example: summary: Default UnlinkDeveloperIdentity 482 response x-microcks-default: true value: example '483': description: ResourceConflictException content: application/json: schema: $ref: '#/components/schemas/ResourceConflictException' examples: UnlinkDeveloperIdentity483Example: summary: Default UnlinkDeveloperIdentity 483 response x-microcks-default: true value: example '484': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: UnlinkDeveloperIdentity484Example: summary: Default UnlinkDeveloperIdentity 484 response x-microcks-default: true value: example '485': description: InternalErrorException content: application/json: schema: $ref: '#/components/schemas/InternalErrorException' examples: UnlinkDeveloperIdentity485Example: summary: Default UnlinkDeveloperIdentity 485 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UnlinkDeveloperIdentityInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityService.UnlinkDeveloperIdentity summary: Amazon Cognito Unlink Developer Identity x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Cognito Identity /#X-Amz-Target=AWSCognitoIdentityService.UnlinkIdentity: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: UnlinkIdentity description: '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.' responses: '200': description: Success '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' examples: UnlinkIdentity480Example: summary: Default UnlinkIdentity 480 response x-microcks-default: true value: example '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: UnlinkIdentity481Example: summary: Default UnlinkIdentity 481 response x-microcks-default: true value: example '482': description: NotAuthorizedException content: application/json: schema: $ref: '#/components/schemas/NotAuthorizedException' examples: UnlinkIdentity482Example: summary: Default UnlinkIdentity 482 response x-microcks-default: true value: example '483': description: ResourceConflictException content: application/json: schema: $ref: '#/components/schemas/ResourceConflictException' examples: UnlinkIdentity483Example: summary: Default UnlinkIdentity 483 response x-microcks-default: true value: example '484': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: UnlinkIdentity484Example: summary: Default UnlinkIdentity 484 response x-microcks-default: true value: example '485': description: InternalErrorException content: application/json: schema: $ref: '#/components/schemas/InternalErrorException' examples: UnlinkIdentity485Example: summary: Default UnlinkIdentity 485 response x-microcks-default: true value: example '486': description: ExternalServiceException content: application/json: schema: $ref: '#/components/schemas/ExternalServiceException' examples: UnlinkIdentity486Example: summary: Default UnlinkIdentity 486 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UnlinkIdentityInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityService.UnlinkIdentity summary: Amazon Cognito Unlink Identity x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Cognito Identity /#X-Amz-Target=AWSCognitoIdentityService.UntagResource: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: UntagResource description: Removes the specified tags from the specified Amazon Cognito identity pool. You can use this action up to 5 times per second, per account responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UntagResourceResponse' examples: UntagResource200Example: summary: Default UntagResource 200 response x-microcks-default: true value: {} '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' examples: UntagResource480Example: summary: Default UntagResource 480 response x-microcks-default: true value: example '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: UntagResource481Example: summary: Default UntagResource 481 response x-microcks-default: true value: example '482': description: NotAuthorizedException content: application/json: schema: $ref: '#/components/schemas/NotAuthorizedException' examples: UntagResource482Example: summary: Default UntagResource 482 response x-microcks-default: true value: example '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: UntagResource483Example: summary: Default UntagResource 483 response x-microcks-default: true value: example '484': description: InternalErrorException content: application/json: schema: $ref: '#/components/schemas/InternalErrorException' examples: UntagResource484Example: summary: Default UntagResource 484 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UntagResourceInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityService.UntagResource summary: Amazon Cognito Untag Resource x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Cognito Identity /#X-Amz-Target=AWSCognitoIdentityService.UpdateIdentityPool: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: UpdateIdentityPool description: 'Updates an identity pool. You must use AWS Developer credentials to call this API.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/IdentityPool' examples: UpdateIdentityPool200Example: summary: Default UpdateIdentityPool 200 response x-microcks-default: true value: IdentityPoolId: example IdentityPoolName: example AllowUnauthenticatedIdentities: example AllowClassicFlow: example SupportedLoginProviders: example DeveloperProviderName: example OpenIdConnectProviderARNs: example CognitoIdentityProviders: example SamlProviderARNs: example IdentityPoolTags: example '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' examples: UpdateIdentityPool480Example: summary: Default UpdateIdentityPool 480 response x-microcks-default: true value: example '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: UpdateIdentityPool481Example: summary: Default UpdateIdentityPool 481 response x-microcks-default: true value: example '482': description: NotAuthorizedException content: application/json: schema: $ref: '#/components/schemas/NotAuthorizedException' examples: UpdateIdentityPool482Example: summary: Default UpdateIdentityPool 482 response x-microcks-default: true value: example '483': description: ResourceConflictException content: application/json: schema: $ref: '#/components/schemas/ResourceConflictException' examples: UpdateIdentityPool483Example: summary: Default UpdateIdentityPool 483 response x-microcks-default: true value: example '484': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: UpdateIdentityPool484Example: summary: Default UpdateIdentityPool 484 response x-microcks-default: true value: example '485': description: InternalErrorException content: application/json: schema: $ref: '#/components/schemas/InternalErrorException' examples: UpdateIdentityPool485Example: summary: Default UpdateIdentityPool 485 response x-microcks-default: true value: example '486': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' examples: UpdateIdentityPool486Example: summary: Default UpdateIdentityPool 486 response x-microcks-default: true value: example '487': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' examples: UpdateIdentityPool487Example: summary: Default UpdateIdentityPool 487 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/IdentityPool' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityService.UpdateIdentityPool summary: Amazon Cognito Update Identity Pool x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Cognito Identity components: schemas: RoleMapping: type: object required: - Type properties: Type: allOf: - $ref: '#/components/schemas/RoleMappingType' - description: 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. AmbiguousRoleResolution: allOf: - $ref: '#/components/schemas/AmbiguousRoleResolutionType' - description:

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.

RulesConfiguration: allOf: - $ref: '#/components/schemas/RulesConfigurationType' - description:

The rules to be used for mapping users to roles.

If you specify Rules as the role mapping type, RulesConfiguration is required.

description: A role mapping. IdentityProviderToken: type: string minLength: 1 maxLength: 50000 PrincipalTags: type: object maxProperties: 50 additionalProperties: $ref: '#/components/schemas/PrincipalTagValue' CreateIdentityPoolInput: type: object required: - IdentityPoolName - AllowUnauthenticatedIdentities title: CreateIdentityPoolInput properties: IdentityPoolName: allOf: - $ref: '#/components/schemas/IdentityPoolName' - description: A string that you provide. AllowUnauthenticatedIdentities: allOf: - $ref: '#/components/schemas/IdentityPoolUnauthenticated' - description: TRUE if the identity pool supports unauthenticated logins. AllowClassicFlow: allOf: - $ref: '#/components/schemas/ClassicFlow' - description: Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide. SupportedLoginProviders: allOf: - $ref: '#/components/schemas/IdentityProviders' - description: Optional key:value pairs mapping provider names to provider app IDs. DeveloperProviderName: allOf: - $ref: '#/components/schemas/DeveloperProviderName' - description:

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.

OpenIdConnectProviderARNs: allOf: - $ref: '#/components/schemas/OIDCProviderList' - description: The Amazon Resource Names (ARN) of the OpenID Connect providers. CognitoIdentityProviders: allOf: - $ref: '#/components/schemas/CognitoIdentityProviderList' - description: An array of Amazon Cognito user pools and their client IDs. SamlProviderARNs: allOf: - $ref: '#/components/schemas/SAMLProviderList' - description: An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool. IdentityPoolTags: allOf: - $ref: '#/components/schemas/IdentityPoolTagsType' - description: Tags to assign to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria. description: Input to the CreateIdentityPool action. TooManyRequestsException: {} CognitoIdentityProviderName: type: string pattern: '[\w._:/-]+' minLength: 1 maxLength: 128 TokenDuration: type: integer minimum: 1 maximum: 86400 TagKeysType: type: string minLength: 1 maxLength: 128 SetPrincipalTagAttributeMapInput: type: object required: - IdentityPoolId - IdentityProviderName title: SetPrincipalTagAttributeMapInput properties: IdentityPoolId: allOf: - $ref: '#/components/schemas/IdentityPoolId' - description: The ID of the Identity Pool you want to set attribute mappings for. IdentityProviderName: allOf: - $ref: '#/components/schemas/IdentityProviderName' - description: The provider name you want to use for attribute mappings. UseDefaults: allOf: - $ref: '#/components/schemas/UseDefaults' - description: You can use this operation to use default (username and clientID) attribute mappings. PrincipalTags: allOf: - $ref: '#/components/schemas/PrincipalTags' - description: You can use this operation to add principal tags. IdentityPoolShortDescription: type: object properties: IdentityPoolId: allOf: - $ref: '#/components/schemas/IdentityPoolId' - description: An identity pool ID in the format REGION:GUID. IdentityPoolName: allOf: - $ref: '#/components/schemas/IdentityPoolName' - description: A string that you provide. description: A description of the identity pool. QueryLimit: type: integer minimum: 1 maximum: 60 AccessKeyString: type: string UntagResourceResponse: type: object properties: {} DeveloperUserIdentifierList: type: array items: $ref: '#/components/schemas/DeveloperUserIdentifier' IdentityIdList: type: array items: $ref: '#/components/schemas/IdentityId' minItems: 1 maxItems: 60 IdentityProviderName: type: string minLength: 1 maxLength: 128 RulesConfigurationType: type: object required: - Rules properties: Rules: allOf: - $ref: '#/components/schemas/MappingRulesList' - description:

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.

description: A container for rules. ResourceNotFoundException: {} GetIdentityPoolRolesInput: type: object required: - IdentityPoolId title: GetIdentityPoolRolesInput properties: IdentityPoolId: allOf: - $ref: '#/components/schemas/IdentityPoolId' - description: An identity pool ID in the format REGION:GUID. description: Input to the GetIdentityPoolRoles action. GetCredentialsForIdentityInput: type: object required: - IdentityId title: GetCredentialsForIdentityInput properties: IdentityId: allOf: - $ref: '#/components/schemas/IdentityId' - description: A unique identifier in the format REGION:GUID. Logins: allOf: - $ref: '#/components/schemas/LoginsMap' - description: '

A set of optional name-value pairs that map provider names to provider tokens. The name-value pair will follow the syntax "provider_name": "provider_user_identifier".

Logins should not be specified when trying to get credentials for an unauthenticated identity.

The Logins parameter is required when using identities associated with external identity providers such as Facebook. For examples of Logins maps, see the code examples in the External Identity Providers section of the Amazon Cognito Developer Guide.

' CustomRoleArn: allOf: - $ref: '#/components/schemas/ARNString' - description: 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. description: Input to the GetCredentialsForIdentity action. IdentityProviders: type: object maxProperties: 10 additionalProperties: $ref: '#/components/schemas/IdentityProviderId' IdentityPool: type: object required: - IdentityPoolId - IdentityPoolName - AllowUnauthenticatedIdentities title: IdentityPool properties: IdentityPoolId: allOf: - $ref: '#/components/schemas/IdentityPoolId' - description: An identity pool ID in the format REGION:GUID. IdentityPoolName: allOf: - $ref: '#/components/schemas/IdentityPoolName' - description: A string that you provide. AllowUnauthenticatedIdentities: allOf: - $ref: '#/components/schemas/IdentityPoolUnauthenticated' - description: TRUE if the identity pool supports unauthenticated logins. AllowClassicFlow: allOf: - $ref: '#/components/schemas/ClassicFlow' - description: Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide. SupportedLoginProviders: allOf: - $ref: '#/components/schemas/IdentityProviders' - description: Optional key:value pairs mapping provider names to provider app IDs. DeveloperProviderName: allOf: - $ref: '#/components/schemas/DeveloperProviderName' - description: The "domain" by which Cognito will refer to your users. OpenIdConnectProviderARNs: allOf: - $ref: '#/components/schemas/OIDCProviderList' - description: The ARNs of the OpenID Connect providers. CognitoIdentityProviders: allOf: - $ref: '#/components/schemas/CognitoIdentityProviderList' - description: A list representing an Amazon Cognito user pool and its client ID. SamlProviderARNs: allOf: - $ref: '#/components/schemas/SAMLProviderList' - description: An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool. IdentityPoolTags: allOf: - $ref: '#/components/schemas/IdentityPoolTagsType' - description: The tags that are assigned to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria. description: An object representing an Amazon Cognito identity pool. AccountId: type: string pattern: \d+ minLength: 1 maxLength: 15 IdentityPoolTagsType: type: object additionalProperties: $ref: '#/components/schemas/TagValueType' CognitoIdentityProvider: type: object properties: ProviderName: allOf: - $ref: '#/components/schemas/CognitoIdentityProviderName' - description: The provider name for an Amazon Cognito user pool. For example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789. ClientId: allOf: - $ref: '#/components/schemas/CognitoIdentityProviderClientId' - description: The client ID for the Amazon Cognito user pool. ServerSideTokenCheck: allOf: - $ref: '#/components/schemas/CognitoIdentityProviderTokenCheck' - description:

TRUE if server-side token validation is enabled for the identity provider’s token.

Once you set ServerSideTokenCheck to TRUE for an identity pool, that identity pool will check with the integrated user pools to make sure that the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.

If the user is signed out or deleted, the identity pool will return a 400 Not Authorized error.

description: A provider representing an Amazon Cognito user pool and its client ID. ListIdentityPoolsInput: type: object required: - MaxResults title: ListIdentityPoolsInput properties: MaxResults: allOf: - $ref: '#/components/schemas/QueryLimit' - description: The maximum number of identities to return. NextToken: allOf: - $ref: '#/components/schemas/PaginationKey' - description: A pagination token. description: Input to the ListIdentityPools action. GetIdInput: type: object required: - IdentityPoolId title: GetIdInput properties: AccountId: allOf: - $ref: '#/components/schemas/AccountId' - description: A standard AWS account ID (9+ digits). IdentityPoolId: allOf: - $ref: '#/components/schemas/IdentityPoolId' - description: An identity pool ID in the format REGION:GUID. Logins: allOf: - $ref: '#/components/schemas/LoginsMap' - description: '

A set of optional name-value pairs that map provider names to provider tokens. The available provider names for Logins are as follows:

' description: Input to the GetId action. GetPrincipalTagAttributeMapResponse: type: object properties: IdentityPoolId: allOf: - $ref: '#/components/schemas/IdentityPoolId' - description: You can use this operation to get the ID of the Identity Pool you setup attribute mappings for. IdentityProviderName: allOf: - $ref: '#/components/schemas/IdentityProviderName' - description: You can use this operation to get the provider name. UseDefaults: allOf: - $ref: '#/components/schemas/UseDefaults' - description: 'You can use this operation to list ' PrincipalTags: allOf: - $ref: '#/components/schemas/PrincipalTags' - description: You can use this operation to add principal tags. The PrincipalTagsoperation enables you to reference user attributes in your IAM permissions policy. ListIdentityPoolsResponse: type: object properties: IdentityPools: allOf: - $ref: '#/components/schemas/IdentityPoolsList' - description: The identity pools returned by the ListIdentityPools action. NextToken: allOf: - $ref: '#/components/schemas/PaginationKey' - description: A pagination token. description: The result of a successful ListIdentityPools action. PrincipalTagValue: type: string minLength: 1 maxLength: 256 SAMLProviderList: type: array items: $ref: '#/components/schemas/ARNString' SetPrincipalTagAttributeMapResponse: type: object properties: IdentityPoolId: allOf: - $ref: '#/components/schemas/IdentityPoolId' - description: The ID of the Identity Pool you want to set attribute mappings for. IdentityProviderName: allOf: - $ref: '#/components/schemas/IdentityProviderName' - description: The provider name you want to use for attribute mappings. UseDefaults: allOf: - $ref: '#/components/schemas/UseDefaults' - description: You can use this operation to select default (username and clientID) attribute mappings. PrincipalTags: allOf: - $ref: '#/components/schemas/PrincipalTags' - description: You can use this operation to add principal tags. The PrincipalTagsoperation enables you to reference user attributes in your IAM permissions policy. CognitoIdentityProviderTokenCheck: type: boolean DeleteIdentitiesInput: type: object required: - IdentityIdsToDelete title: DeleteIdentitiesInput properties: IdentityIdsToDelete: allOf: - $ref: '#/components/schemas/IdentityIdList' - description: A list of 1-60 identities that you want to delete. description: Input to the DeleteIdentities action. OIDCToken: type: string RoleMappingType: type: string enum: - Token - Rules LookupDeveloperIdentityResponse: type: object properties: IdentityId: allOf: - $ref: '#/components/schemas/IdentityId' - description: A unique identifier in the format REGION:GUID. DeveloperUserIdentifierList: allOf: - $ref: '#/components/schemas/DeveloperUserIdentifierList' - description: 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. NextToken: allOf: - $ref: '#/components/schemas/PaginationKey' - description: 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. description: Returned in response to a successful LookupDeveloperIdentity action. GetIdentityPoolRolesResponse: type: object properties: IdentityPoolId: allOf: - $ref: '#/components/schemas/IdentityPoolId' - description: An identity pool ID in the format REGION:GUID. Roles: allOf: - $ref: '#/components/schemas/RolesMap' - description: The map of roles associated with this pool. Currently only authenticated and unauthenticated roles are supported. RoleMappings: allOf: - $ref: '#/components/schemas/RoleMappingMap' - description: How users for a specific identity provider are to mapped to roles. This is a String-to-RoleMapping object map. The string identifies the identity provider, for example, "graph.facebook.com" or "cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id". description: Returned in response to a successful GetIdentityPoolRoles operation. LoginsMap: type: object maxProperties: 10 additionalProperties: $ref: '#/components/schemas/IdentityProviderToken' IdentityPoolId: type: string pattern: '[\w-]+:[0-9a-f-]+' minLength: 1 maxLength: 55 Credentials: type: object properties: AccessKeyId: allOf: - $ref: '#/components/schemas/AccessKeyString' - description: The Access Key portion of the credentials. SecretKey: allOf: - $ref: '#/components/schemas/SecretKeyString' - description: The Secret Access Key portion of the credentials SessionToken: allOf: - $ref: '#/components/schemas/SessionTokenString' - description: The Session Token portion of the credentials Expiration: allOf: - $ref: '#/components/schemas/DateType' - description: The date at which these credentials will expire. description: Credentials for the provided identity ID. UnlinkIdentityInput: type: object required: - IdentityId - Logins - LoginsToRemove title: UnlinkIdentityInput properties: IdentityId: allOf: - $ref: '#/components/schemas/IdentityId' - description: A unique identifier in the format REGION:GUID. Logins: allOf: - $ref: '#/components/schemas/LoginsMap' - description: A set of optional name-value pairs that map provider names to provider tokens. LoginsToRemove: allOf: - $ref: '#/components/schemas/LoginsList' - description: Provider names to unlink from this identity. description: Input to the UnlinkIdentity action. IdentityProviderId: type: string pattern: '[\w.;_/-]+' minLength: 1 maxLength: 128 UnprocessedIdentityId: type: object properties: IdentityId: allOf: - $ref: '#/components/schemas/IdentityId' - description: A unique identifier in the format REGION:GUID. ErrorCode: allOf: - $ref: '#/components/schemas/ErrorCode' - description: The error code indicating the type of error that occurred. description: An array of UnprocessedIdentityId objects, each of which contains an ErrorCode and IdentityId. GetCredentialsForIdentityResponse: type: object properties: IdentityId: allOf: - $ref: '#/components/schemas/IdentityId' - description: A unique identifier in the format REGION:GUID. Credentials: allOf: - $ref: '#/components/schemas/Credentials' - description: Credentials for the provided identity ID. description: Returned in response to a successful GetCredentialsForIdentity operation. ExternalServiceException: {} TagResourceResponse: type: object properties: {} SetIdentityPoolRolesInput: type: object required: - IdentityPoolId - Roles title: SetIdentityPoolRolesInput properties: IdentityPoolId: allOf: - $ref: '#/components/schemas/IdentityPoolId' - description: An identity pool ID in the format REGION:GUID. Roles: allOf: - $ref: '#/components/schemas/RolesMap' - description: 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. RoleMappings: allOf: - $ref: '#/components/schemas/RoleMappingMap' - description:

How users for a specific identity provider are to mapped to roles. This is a string to RoleMapping object map. The string identifies the identity provider, for example, "graph.facebook.com" or "cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id".

Up to 25 rules can be specified per identity provider.

description: Input to the SetIdentityPoolRoles action. ListTagsForResourceResponse: type: object properties: Tags: allOf: - $ref: '#/components/schemas/IdentityPoolTagsType' - description: The tags that are assigned to the identity pool. ListIdentitiesInput: type: object required: - IdentityPoolId - MaxResults title: ListIdentitiesInput properties: IdentityPoolId: allOf: - $ref: '#/components/schemas/IdentityPoolId' - description: An identity pool ID in the format REGION:GUID. MaxResults: allOf: - $ref: '#/components/schemas/QueryLimit' - description: The maximum number of identities to return. NextToken: allOf: - $ref: '#/components/schemas/PaginationKey' - description: A pagination token. HideDisabled: allOf: - $ref: '#/components/schemas/HideDisabled' - description: An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response. description: Input to the ListIdentities action. DeleteIdentityPoolInput: type: object required: - IdentityPoolId title: DeleteIdentityPoolInput properties: IdentityPoolId: allOf: - $ref: '#/components/schemas/IdentityPoolId' - description: An identity pool ID in the format REGION:GUID. description: Input to the DeleteIdentityPool action. UntagResourceInput: type: object required: - ResourceArn - TagKeys title: UntagResourceInput properties: ResourceArn: allOf: - $ref: '#/components/schemas/ARNString' - description: The Amazon Resource Name (ARN) of the identity pool. TagKeys: allOf: - $ref: '#/components/schemas/IdentityPoolTagsListType' - description: The keys of the tags to remove from the user pool. GetPrincipalTagAttributeMapInput: type: object required: - IdentityPoolId - IdentityProviderName title: GetPrincipalTagAttributeMapInput properties: IdentityPoolId: allOf: - $ref: '#/components/schemas/IdentityPoolId' - description: You can use this operation to get the ID of the Identity Pool you setup attribute mappings for. IdentityProviderName: allOf: - $ref: '#/components/schemas/IdentityProviderName' - description: You can use this operation to get the provider name. ListIdentitiesResponse: type: object properties: IdentityPoolId: allOf: - $ref: '#/components/schemas/IdentityPoolId' - description: An identity pool ID in the format REGION:GUID. Identities: allOf: - $ref: '#/components/schemas/IdentitiesList' - description: An object containing a set of identities and associated mappings. NextToken: allOf: - $ref: '#/components/schemas/PaginationKey' - description: A pagination token. description: The response to a ListIdentities request. ARNString: type: string minLength: 20 maxLength: 2048 DeleteIdentitiesResponse: type: object properties: UnprocessedIdentityIds: allOf: - $ref: '#/components/schemas/UnprocessedIdentityIdList' - description: An array of UnprocessedIdentityId objects, each of which contains an ErrorCode and IdentityId. description: Returned in response to a successful DeleteIdentities operation. InvalidIdentityPoolConfigurationException: {} GetOpenIdTokenInput: type: object required: - IdentityId title: GetOpenIdTokenInput properties: IdentityId: allOf: - $ref: '#/components/schemas/IdentityId' - description: A unique identifier in the format REGION:GUID. Logins: allOf: - $ref: '#/components/schemas/LoginsMap' - description: A set of optional name-value pairs that map provider names to provider tokens. When using graph.facebook.com and www.amazon.com, supply the access_token returned from the provider's authflow. For accounts.google.com, an Amazon Cognito user pool provider, or any other OpenID Connect provider, always include the id_token. description: Input to the GetOpenIdToken action. HideDisabled: type: boolean UseDefaults: type: boolean RoleMappingMap: type: object maxProperties: 10 additionalProperties: $ref: '#/components/schemas/RoleMapping' MappingRulesList: type: array items: $ref: '#/components/schemas/MappingRule' minItems: 1 maxItems: 400 IdentityPoolName: type: string pattern: '[\w\s+=,.@-]+' minLength: 1 maxLength: 128 PaginationKey: type: string pattern: '[\S]+' minLength: 1 maxLength: 65535 NotAuthorizedException: {} IdentityPoolUnauthenticated: type: boolean TagResourceInput: type: object required: - ResourceArn - Tags title: TagResourceInput properties: ResourceArn: allOf: - $ref: '#/components/schemas/ARNString' - description: The Amazon Resource Name (ARN) of the identity pool. Tags: allOf: - $ref: '#/components/schemas/IdentityPoolTagsType' - description: The tags to assign to the identity pool. SecretKeyString: type: string MappingRuleMatchType: type: string enum: - Equals - Contains - StartsWith - NotEqual MergeDeveloperIdentitiesResponse: type: object properties: IdentityId: allOf: - $ref: '#/components/schemas/IdentityId' - description: A unique identifier in the format REGION:GUID. description: Returned in response to a successful MergeDeveloperIdentities action. LimitExceededException: {} TagValueType: type: string minLength: 0 maxLength: 256 OIDCProviderList: type: array items: $ref: '#/components/schemas/ARNString' DeveloperProviderName: type: string pattern: '[\w._-]+' minLength: 1 maxLength: 128 DeveloperUserIdentifier: type: string minLength: 1 maxLength: 1024 ErrorCode: type: string enum: - AccessDenied - InternalServerError ListTagsForResourceInput: type: object required: - ResourceArn title: ListTagsForResourceInput properties: ResourceArn: allOf: - $ref: '#/components/schemas/ARNString' - description: The Amazon Resource Name (ARN) of the identity pool that the tags are assigned to. GetOpenIdTokenForDeveloperIdentityResponse: type: object properties: IdentityId: allOf: - $ref: '#/components/schemas/IdentityId' - description: A unique identifier in the format REGION:GUID. Token: allOf: - $ref: '#/components/schemas/OIDCToken' - description: An OpenID token. description: Returned in response to a successful GetOpenIdTokenForDeveloperIdentity request. RolesMap: type: object maxProperties: 2 additionalProperties: $ref: '#/components/schemas/ARNString' InternalErrorException: {} LoginsList: type: array items: $ref: '#/components/schemas/IdentityProviderName' UnprocessedIdentityIdList: type: array items: $ref: '#/components/schemas/UnprocessedIdentityId' maxItems: 60 IdentityId: type: string pattern: '[\w-]+:[0-9a-f-]+' minLength: 1 maxLength: 55 SessionTokenString: type: string CognitoIdentityProviderClientId: type: string pattern: '[\w_]+' minLength: 1 maxLength: 128 IdentitiesList: type: array items: $ref: '#/components/schemas/IdentityDescription' ClaimValue: type: string minLength: 1 maxLength: 128 ClassicFlow: type: boolean AmbiguousRoleResolutionType: type: string enum: - AuthenticatedRole - Deny ConcurrentModificationException: {} IdentityDescription: type: object properties: IdentityId: allOf: - $ref: '#/components/schemas/IdentityId' - description: A unique identifier in the format REGION:GUID. Logins: allOf: - $ref: '#/components/schemas/LoginsList' - description: The provider names. CreationDate: allOf: - $ref: '#/components/schemas/DateType' - description: Date on which the identity was created. LastModifiedDate: allOf: - $ref: '#/components/schemas/DateType' - description: Date on which the identity was last modified. description: A description of the identity. DescribeIdentityPoolInput: type: object required: - IdentityPoolId title: DescribeIdentityPoolInput properties: IdentityPoolId: allOf: - $ref: '#/components/schemas/IdentityPoolId' - description: An identity pool ID in the format REGION:GUID. description: Input to the DescribeIdentityPool action. UnlinkDeveloperIdentityInput: type: object required: - IdentityId - IdentityPoolId - DeveloperProviderName - DeveloperUserIdentifier title: UnlinkDeveloperIdentityInput properties: IdentityId: allOf: - $ref: '#/components/schemas/IdentityId' - description: A unique identifier in the format REGION:GUID. IdentityPoolId: allOf: - $ref: '#/components/schemas/IdentityPoolId' - description: An identity pool ID in the format REGION:GUID. DeveloperProviderName: allOf: - $ref: '#/components/schemas/DeveloperProviderName' - description: The "domain" by which Cognito will refer to your users. DeveloperUserIdentifier: allOf: - $ref: '#/components/schemas/DeveloperUserIdentifier' - description: A unique ID used by your backend authentication process to identify a user. description: Input to the UnlinkDeveloperIdentity action. GetOpenIdTokenResponse: type: object properties: IdentityId: allOf: - $ref: '#/components/schemas/IdentityId' - description: A unique identifier in the format REGION:GUID. Note that the IdentityId returned may not match the one passed on input. Token: allOf: - $ref: '#/components/schemas/OIDCToken' - description: An OpenID token, valid for 10 minutes. description: Returned in response to a successful GetOpenIdToken request. DateType: type: string format: date-time GetIdResponse: type: object properties: IdentityId: allOf: - $ref: '#/components/schemas/IdentityId' - description: A unique identifier in the format REGION:GUID. description: Returned in response to a GetId request. GetOpenIdTokenForDeveloperIdentityInput: type: object required: - IdentityPoolId - Logins title: GetOpenIdTokenForDeveloperIdentityInput properties: IdentityPoolId: allOf: - $ref: '#/components/schemas/IdentityPoolId' - description: An identity pool ID in the format REGION:GUID. IdentityId: allOf: - $ref: '#/components/schemas/IdentityId' - description: A unique identifier in the format REGION:GUID. Logins: allOf: - $ref: '#/components/schemas/LoginsMap' - description: '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.' PrincipalTags: allOf: - $ref: '#/components/schemas/PrincipalTags' - description: 'Use this operation to configure attribute mappings for custom providers. ' TokenDuration: allOf: - $ref: '#/components/schemas/TokenDuration' - description: '

The expiration time of the token, in seconds. You can specify a custom expiration time for the token so that you can cache it. If you don''t provide an expiration time, the token is valid for 15 minutes. You can exchange the token with Amazon STS for temporary AWS credentials, which are valid for a maximum of one hour. The maximum token duration you can set is 24 hours. You should take care in setting the expiration time for a token, as there are significant security implications: an attacker could use a leaked token to access your AWS resources for the token''s duration.

Please provide for a small grace period, usually no more than 5 minutes, to account for clock skew.

' description: Input to the GetOpenIdTokenForDeveloperIdentity action. ClaimName: type: string pattern: '[\p{L}\p{M}\p{S}\p{N}\p{P}]+' minLength: 1 maxLength: 64 ResourceConflictException: {} DeveloperUserAlreadyRegisteredException: {} LookupDeveloperIdentityInput: type: object required: - IdentityPoolId title: LookupDeveloperIdentityInput properties: IdentityPoolId: allOf: - $ref: '#/components/schemas/IdentityPoolId' - description: An identity pool ID in the format REGION:GUID. IdentityId: allOf: - $ref: '#/components/schemas/IdentityId' - description: A unique identifier in the format REGION:GUID. DeveloperUserIdentifier: allOf: - $ref: '#/components/schemas/DeveloperUserIdentifier' - description: 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. MaxResults: allOf: - $ref: '#/components/schemas/QueryLimit' - description: The maximum number of identities to return. NextToken: allOf: - $ref: '#/components/schemas/PaginationKey' - description: 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. description: Input to the LookupDeveloperIdentityInput action. IdentityPoolTagsListType: type: array items: $ref: '#/components/schemas/TagKeysType' InvalidParameterException: {} CognitoIdentityProviderList: type: array items: $ref: '#/components/schemas/CognitoIdentityProvider' MappingRule: type: object required: - Claim - MatchType - Value - RoleARN properties: Claim: allOf: - $ref: '#/components/schemas/ClaimName' - description: The claim name that must be present in the token, for example, "isAdmin" or "paid". MatchType: allOf: - $ref: '#/components/schemas/MappingRuleMatchType' - description: The match condition that specifies how closely the claim value in the IdP token must match Value. Value: allOf: - $ref: '#/components/schemas/ClaimValue' - description: A brief string that the claim must match, for example, "paid" or "yes". RoleARN: allOf: - $ref: '#/components/schemas/ARNString' - description: The role ARN. description: A rule that maps a claim name, a claim value, and a match type to a role ARN. MergeDeveloperIdentitiesInput: type: object required: - SourceUserIdentifier - DestinationUserIdentifier - DeveloperProviderName - IdentityPoolId title: MergeDeveloperIdentitiesInput properties: SourceUserIdentifier: allOf: - $ref: '#/components/schemas/DeveloperUserIdentifier' - description: User identifier for the source user. The value should be a DeveloperUserIdentifier. DestinationUserIdentifier: allOf: - $ref: '#/components/schemas/DeveloperUserIdentifier' - description: User identifier for the destination user. The value should be a DeveloperUserIdentifier. DeveloperProviderName: allOf: - $ref: '#/components/schemas/DeveloperProviderName' - description: 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 (-). IdentityPoolId: allOf: - $ref: '#/components/schemas/IdentityPoolId' - description: An identity pool ID in the format REGION:GUID. description: Input to the MergeDeveloperIdentities action. IdentityPoolsList: type: array items: $ref: '#/components/schemas/IdentityPoolShortDescription' DescribeIdentityInput: type: object required: - IdentityId title: DescribeIdentityInput properties: IdentityId: allOf: - $ref: '#/components/schemas/IdentityId' - description: A unique identifier in the format REGION:GUID. description: Input to the DescribeIdentity action. parameters: X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/cognito-identity/ x-hasEquivalentPaths: true