root
/
gl-store-s3.js
mirror of https://github.com/cderche/greenlock-storage-s3
2
0
Fork 0
Code Issues 1 Releases Wiki Activity
gl-store-s3.js/node_modules/aws-sdk/clients/cognitoidentity.d.ts

765 lines
46 KiB
TypeScript
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config';
interface Blob {}
declare class CognitoIdentity extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: CognitoIdentity.Types.ClientConfiguration)
config: Config & CognitoIdentity.Types.ClientConfiguration;
/**
* Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account. The limit on identity pools is 60 per account. The keys for SupportedLoginProviders are as follows: Facebook: graph.facebook.com Google: accounts.google.com Amazon: www.amazon.com Twitter: api.twitter.com Digits: www.digits.com You must use AWS Developer credentials to call this API.
*/
createIdentityPool(params: CognitoIdentity.Types.CreateIdentityPoolInput, callback?: (err: AWSError, data: CognitoIdentity.Types.IdentityPool) => void): Request<CognitoIdentity.Types.IdentityPool, AWSError>;
/**
* Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account. The limit on identity pools is 60 per account. The keys for SupportedLoginProviders are as follows: Facebook: graph.facebook.com Google: accounts.google.com Amazon: www.amazon.com Twitter: api.twitter.com Digits: www.digits.com You must use AWS Developer credentials to call this API.
*/
createIdentityPool(callback?: (err: AWSError, data: CognitoIdentity.Types.IdentityPool) => void): Request<CognitoIdentity.Types.IdentityPool, AWSError>;
/**
* 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.
*/
deleteIdentities(params: CognitoIdentity.Types.DeleteIdentitiesInput, callback?: (err: AWSError, data: CognitoIdentity.Types.DeleteIdentitiesResponse) => void): Request<CognitoIdentity.Types.DeleteIdentitiesResponse, AWSError>;
/**
* 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.
*/
deleteIdentities(callback?: (err: AWSError, data: CognitoIdentity.Types.DeleteIdentitiesResponse) => void): Request<CognitoIdentity.Types.DeleteIdentitiesResponse, AWSError>;
/**
* 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.
*/
deleteIdentityPool(params: CognitoIdentity.Types.DeleteIdentityPoolInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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.
*/
deleteIdentityPool(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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.
*/
describeIdentity(params: CognitoIdentity.Types.DescribeIdentityInput, callback?: (err: AWSError, data: CognitoIdentity.Types.IdentityDescription) => void): Request<CognitoIdentity.Types.IdentityDescription, AWSError>;
/**
* 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.
*/
describeIdentity(callback?: (err: AWSError, data: CognitoIdentity.Types.IdentityDescription) => void): Request<CognitoIdentity.Types.IdentityDescription, AWSError>;
/**
* 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.
*/
describeIdentityPool(params: CognitoIdentity.Types.DescribeIdentityPoolInput, callback?: (err: AWSError, data: CognitoIdentity.Types.IdentityPool) => void): Request<CognitoIdentity.Types.IdentityPool, AWSError>;
/**
* 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.
*/
describeIdentityPool(callback?: (err: AWSError, data: CognitoIdentity.Types.IdentityPool) => void): Request<CognitoIdentity.Types.IdentityPool, AWSError>;
/**
* 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.
*/
getCredentialsForIdentity(params: CognitoIdentity.Types.GetCredentialsForIdentityInput, callback?: (err: AWSError, data: CognitoIdentity.Types.GetCredentialsForIdentityResponse) => void): Request<CognitoIdentity.Types.GetCredentialsForIdentityResponse, AWSError>;
/**
* 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.
*/
getCredentialsForIdentity(callback?: (err: AWSError, data: CognitoIdentity.Types.GetCredentialsForIdentityResponse) => void): Request<CognitoIdentity.Types.GetCredentialsForIdentityResponse, AWSError>;
/**
* 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.
*/
getId(params: CognitoIdentity.Types.GetIdInput, callback?: (err: AWSError, data: CognitoIdentity.Types.GetIdResponse) => void): Request<CognitoIdentity.Types.GetIdResponse, AWSError>;
/**
* 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.
*/
getId(callback?: (err: AWSError, data: CognitoIdentity.Types.GetIdResponse) => void): Request<CognitoIdentity.Types.GetIdResponse, AWSError>;
/**
* Gets the roles for an identity pool. You must use AWS Developer credentials to call this API.
*/
getIdentityPoolRoles(params: CognitoIdentity.Types.GetIdentityPoolRolesInput, callback?: (err: AWSError, data: CognitoIdentity.Types.GetIdentityPoolRolesResponse) => void): Request<CognitoIdentity.Types.GetIdentityPoolRolesResponse, AWSError>;
/**
* Gets the roles for an identity pool. You must use AWS Developer credentials to call this API.
*/
getIdentityPoolRoles(callback?: (err: AWSError, data: CognitoIdentity.Types.GetIdentityPoolRolesResponse) => void): Request<CognitoIdentity.Types.GetIdentityPoolRolesResponse, AWSError>;
/**
* 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.
*/
getOpenIdToken(params: CognitoIdentity.Types.GetOpenIdTokenInput, callback?: (err: AWSError, data: CognitoIdentity.Types.GetOpenIdTokenResponse) => void): Request<CognitoIdentity.Types.GetOpenIdTokenResponse, AWSError>;
/**
* 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.
*/
getOpenIdToken(callback?: (err: AWSError, data: CognitoIdentity.Types.GetOpenIdTokenResponse) => void): Request<CognitoIdentity.Types.GetOpenIdTokenResponse, AWSError>;
/**
* 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.
*/
getOpenIdTokenForDeveloperIdentity(params: CognitoIdentity.Types.GetOpenIdTokenForDeveloperIdentityInput, callback?: (err: AWSError, data: CognitoIdentity.Types.GetOpenIdTokenForDeveloperIdentityResponse) => void): Request<CognitoIdentity.Types.GetOpenIdTokenForDeveloperIdentityResponse, AWSError>;
/**
* 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.
*/
getOpenIdTokenForDeveloperIdentity(callback?: (err: AWSError, data: CognitoIdentity.Types.GetOpenIdTokenForDeveloperIdentityResponse) => void): Request<CognitoIdentity.Types.GetOpenIdTokenForDeveloperIdentityResponse, AWSError>;
/**
* Lists the identities in an identity pool. You must use AWS Developer credentials to call this API.
*/
listIdentities(params: CognitoIdentity.Types.ListIdentitiesInput, callback?: (err: AWSError, data: CognitoIdentity.Types.ListIdentitiesResponse) => void): Request<CognitoIdentity.Types.ListIdentitiesResponse, AWSError>;
/**
* Lists the identities in an identity pool. You must use AWS Developer credentials to call this API.
*/
listIdentities(callback?: (err: AWSError, data: CognitoIdentity.Types.ListIdentitiesResponse) => void): Request<CognitoIdentity.Types.ListIdentitiesResponse, AWSError>;
/**
* Lists all of the Cognito identity pools registered for your account. You must use AWS Developer credentials to call this API.
*/
listIdentityPools(params: CognitoIdentity.Types.ListIdentityPoolsInput, callback?: (err: AWSError, data: CognitoIdentity.Types.ListIdentityPoolsResponse) => void): Request<CognitoIdentity.Types.ListIdentityPoolsResponse, AWSError>;
/**
* Lists all of the Cognito identity pools registered for your account. You must use AWS Developer credentials to call this API.
*/
listIdentityPools(callback?: (err: AWSError, data: CognitoIdentity.Types.ListIdentityPoolsResponse) => void): Request<CognitoIdentity.Types.ListIdentityPoolsResponse, AWSError>;
/**
* 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.
*/
listTagsForResource(params: CognitoIdentity.Types.ListTagsForResourceInput, callback?: (err: AWSError, data: CognitoIdentity.Types.ListTagsForResourceResponse) => void): Request<CognitoIdentity.Types.ListTagsForResourceResponse, AWSError>;
/**
* 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.
*/
listTagsForResource(callback?: (err: AWSError, data: CognitoIdentity.Types.ListTagsForResourceResponse) => void): Request<CognitoIdentity.Types.ListTagsForResourceResponse, AWSError>;
/**
* 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.
*/
lookupDeveloperIdentity(params: CognitoIdentity.Types.LookupDeveloperIdentityInput, callback?: (err: AWSError, data: CognitoIdentity.Types.LookupDeveloperIdentityResponse) => void): Request<CognitoIdentity.Types.LookupDeveloperIdentityResponse, AWSError>;
/**
* 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.
*/
lookupDeveloperIdentity(callback?: (err: AWSError, data: CognitoIdentity.Types.LookupDeveloperIdentityResponse) => void): Request<CognitoIdentity.Types.LookupDeveloperIdentityResponse, AWSError>;
/**
* 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.
*/
mergeDeveloperIdentities(params: CognitoIdentity.Types.MergeDeveloperIdentitiesInput, callback?: (err: AWSError, data: CognitoIdentity.Types.MergeDeveloperIdentitiesResponse) => void): Request<CognitoIdentity.Types.MergeDeveloperIdentitiesResponse, AWSError>;
/**
* 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.
*/
mergeDeveloperIdentities(callback?: (err: AWSError, data: CognitoIdentity.Types.MergeDeveloperIdentitiesResponse) => void): Request<CognitoIdentity.Types.MergeDeveloperIdentitiesResponse, AWSError>;
/**
* 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.
*/
setIdentityPoolRoles(params: CognitoIdentity.Types.SetIdentityPoolRolesInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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.
*/
setIdentityPoolRoles(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Assigns a set of tags to an Amazon Cognito identity pool. A tag is a label that you can use to categorize and manage identity pools in different ways, such as by purpose, owner, environment, or other criteria. Each tag consists of a key and value, both of which you define. A key is a general category for more specific values. For example, if you have two versions of an identity pool, one for testing and another for production, you might assign an Environment tag key to both identity pools. The value of this key might be Test for one identity pool and Production for the other. Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your identity pools. In an IAM policy, you can constrain permissions for identity pools based on specific tags or tag values. You can use this action up to 5 times per second, per account. An identity pool can have as many as 50 tags.
*/
tagResource(params: CognitoIdentity.Types.TagResourceInput, callback?: (err: AWSError, data: CognitoIdentity.Types.TagResourceResponse) => void): Request<CognitoIdentity.Types.TagResourceResponse, AWSError>;
/**
* Assigns a set of tags to an Amazon Cognito identity pool. A tag is a label that you can use to categorize and manage identity pools in different ways, such as by purpose, owner, environment, or other criteria. Each tag consists of a key and value, both of which you define. A key is a general category for more specific values. For example, if you have two versions of an identity pool, one for testing and another for production, you might assign an Environment tag key to both identity pools. The value of this key might be Test for one identity pool and Production for the other. Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your identity pools. In an IAM policy, you can constrain permissions for identity pools based on specific tags or tag values. You can use this action up to 5 times per second, per account. An identity pool can have as many as 50 tags.
*/
tagResource(callback?: (err: AWSError, data: CognitoIdentity.Types.TagResourceResponse) => void): Request<CognitoIdentity.Types.TagResourceResponse, AWSError>;
/**
* 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.
*/
unlinkDeveloperIdentity(params: CognitoIdentity.Types.UnlinkDeveloperIdentityInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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.
*/
unlinkDeveloperIdentity(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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.
*/
unlinkIdentity(params: CognitoIdentity.Types.UnlinkIdentityInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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.
*/
unlinkIdentity(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes the specified tags from an Amazon Cognito identity pool. You can use this action up to 5 times per second, per account
*/
untagResource(params: CognitoIdentity.Types.UntagResourceInput, callback?: (err: AWSError, data: CognitoIdentity.Types.UntagResourceResponse) => void): Request<CognitoIdentity.Types.UntagResourceResponse, AWSError>;
/**
* Removes the specified tags from an Amazon Cognito identity pool. You can use this action up to 5 times per second, per account
*/
untagResource(callback?: (err: AWSError, data: CognitoIdentity.Types.UntagResourceResponse) => void): Request<CognitoIdentity.Types.UntagResourceResponse, AWSError>;
/**
* Updates an identity pool. You must use AWS Developer credentials to call this API.
*/
updateIdentityPool(params: CognitoIdentity.Types.IdentityPool, callback?: (err: AWSError, data: CognitoIdentity.Types.IdentityPool) => void): Request<CognitoIdentity.Types.IdentityPool, AWSError>;
/**
* Updates an identity pool. You must use AWS Developer credentials to call this API.
*/
updateIdentityPool(callback?: (err: AWSError, data: CognitoIdentity.Types.IdentityPool) => void): Request<CognitoIdentity.Types.IdentityPool, AWSError>;
}
declare namespace CognitoIdentity {
export type ARNString = string;
export type AccessKeyString = string;
export type AccountId = string;
export type AmbiguousRoleResolutionType = "AuthenticatedRole"|"Deny"|string;
export type ClaimName = string;
export type ClaimValue = string;
export interface CognitoIdentityProvider {
/**
* The provider name for an Amazon Cognito user pool. For example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789.
*/
ProviderName?: CognitoIdentityProviderName;
/**
* The client ID for the Amazon Cognito user pool.
*/
ClientId?: CognitoIdentityProviderClientId;
/**
* TRUE if server-side token validation is enabled for the identity provider’s token. Once you set ServerSideTokenCheck to TRUE for an identity pool, that identity pool will check with the integrated user pools to make sure that the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user. If the user is signed out or deleted, the identity pool will return a 400 Not Authorized error.
*/
ServerSideTokenCheck?: CognitoIdentityProviderTokenCheck;
}
export type CognitoIdentityProviderClientId = string;
export type CognitoIdentityProviderList = CognitoIdentityProvider[];
export type CognitoIdentityProviderName = string;
export type CognitoIdentityProviderTokenCheck = boolean;
export interface CreateIdentityPoolInput {
/**
* A string that you provide.
*/
IdentityPoolName: IdentityPoolName;
/**
* TRUE if the identity pool supports unauthenticated logins.
*/
AllowUnauthenticatedIdentities: IdentityPoolUnauthenticated;
/**
* Optional key:value pairs mapping provider names to provider app IDs.
*/
SupportedLoginProviders?: IdentityProviders;
/**
* The "domain" by which Cognito will refer to your users. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName, you can use letters as well as period (.), underscore (_), and dash (-). Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter.
*/
DeveloperProviderName?: DeveloperProviderName;
/**
* A list of OpendID Connect provider ARNs.
*/
OpenIdConnectProviderARNs?: OIDCProviderList;
/**
* An array of Amazon Cognito user pools and their client IDs.
*/
CognitoIdentityProviders?: CognitoIdentityProviderList;
/**
* An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
*/
SamlProviderARNs?: SAMLProviderList;
/**
* Tags to assign to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
*/
IdentityPoolTags?: IdentityPoolTagsType;
}
export interface Credentials {
/**
* The Access Key portion of the credentials.
*/
AccessKeyId?: AccessKeyString;
/**
* The Secret Access Key portion of the credentials
*/
SecretKey?: SecretKeyString;
/**
* The Session Token portion of the credentials
*/
SessionToken?: SessionTokenString;
/**
* The date at which these credentials will expire.
*/
Expiration?: DateType;
}
export type DateType = Date;
export interface DeleteIdentitiesInput {
/**
* A list of 1-60 identities that you want to delete.
*/
IdentityIdsToDelete: IdentityIdList;
}
export interface DeleteIdentitiesResponse {
/**
* An array of UnprocessedIdentityId objects, each of which contains an ErrorCode and IdentityId.
*/
UnprocessedIdentityIds?: UnprocessedIdentityIdList;
}
export interface DeleteIdentityPoolInput {
/**
* An identity pool ID in the format REGION:GUID.
*/
IdentityPoolId: IdentityPoolId;
}
export interface DescribeIdentityInput {
/**
* A unique identifier in the format REGION:GUID.
*/
IdentityId: IdentityId;
}
export interface DescribeIdentityPoolInput {
/**
* An identity pool ID in the format REGION:GUID.
*/
IdentityPoolId: IdentityPoolId;
}
export type DeveloperProviderName = string;
export type DeveloperUserIdentifier = string;
export type DeveloperUserIdentifierList = DeveloperUserIdentifier[];
export type ErrorCode = "AccessDenied"|"InternalServerError"|string;
export interface GetCredentialsForIdentityInput {
/**
* A unique identifier in the format REGION:GUID.
*/
IdentityId: IdentityId;
/**
* 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.
*/
Logins?: LoginsMap;
/**
* The Amazon Resource Name (ARN) of the role to be assumed when multiple roles were received in the token from the identity provider. For example, a SAML-based identity provider. This parameter is optional for identity providers that do not support role customization.
*/
CustomRoleArn?: ARNString;
}
export interface GetCredentialsForIdentityResponse {
/**
* A unique identifier in the format REGION:GUID.
*/
IdentityId?: IdentityId;
/**
* Credentials for the provided identity ID.
*/
Credentials?: Credentials;
}
export interface GetIdInput {
/**
* A standard AWS account ID (9+ digits).
*/
AccountId?: AccountId;
/**
* An identity pool ID in the format REGION:GUID.
*/
IdentityPoolId: IdentityPoolId;
/**
* A set of optional name-value pairs that map provider names to provider tokens. The available provider names for Logins are as follows: Facebook: graph.facebook.com Amazon Cognito user pool: cognito-idp.&lt;region&gt;.amazonaws.com/&lt;YOUR_USER_POOL_ID&gt;, for example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789. Google: accounts.google.com Amazon: www.amazon.com Twitter: api.twitter.com Digits: www.digits.com
*/
Logins?: LoginsMap;
}
export interface GetIdResponse {
/**
* A unique identifier in the format REGION:GUID.
*/
IdentityId?: IdentityId;
}
export interface GetIdentityPoolRolesInput {
/**
* An identity pool ID in the format REGION:GUID.
*/
IdentityPoolId: IdentityPoolId;
}
export interface GetIdentityPoolRolesResponse {
/**
* An identity pool ID in the format REGION:GUID.
*/
IdentityPoolId?: IdentityPoolId;
/**
* The map of roles associated with this pool. Currently only authenticated and unauthenticated roles are supported.
*/
Roles?: RolesMap;
/**
* How users for a specific identity provider are to mapped to roles. This is a String-to-RoleMapping object map. The string identifies the identity provider, for example, "graph.facebook.com" or "cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id".
*/
RoleMappings?: RoleMappingMap;
}
export interface GetOpenIdTokenForDeveloperIdentityInput {
/**
* An identity pool ID in the format REGION:GUID.
*/
IdentityPoolId: IdentityPoolId;
/**
* A unique identifier in the format REGION:GUID.
*/
IdentityId?: IdentityId;
/**
* A set of optional name-value pairs that map provider names to provider tokens. Each name-value pair represents a user from a public provider or developer provider. If the user is from a developer provider, the name-value pair will follow the syntax "developer_provider_name": "developer_user_identifier". The developer provider is the "domain" by which Cognito will refer to your users; you provided this domain while creating/updating the identity pool. The developer user identifier is an identifier from your backend that uniquely identifies a user. When you create an identity pool, you can specify the supported logins.
*/
Logins: LoginsMap;
/**
* The expiration time of the token, in seconds. You can specify a custom expiration time for the token so that you can cache it. If you don't provide an expiration time, the token is valid for 15 minutes. You can exchange the token with Amazon STS for temporary AWS credentials, which are valid for a maximum of one hour. The maximum token duration you can set is 24 hours. You should take care in setting the expiration time for a token, as there are significant security implications: an attacker could use a leaked token to access your AWS resources for the token's duration.
*/
TokenDuration?: TokenDuration;
}
export interface GetOpenIdTokenForDeveloperIdentityResponse {
/**
* A unique identifier in the format REGION:GUID.
*/
IdentityId?: IdentityId;
/**
* An OpenID token.
*/
Token?: OIDCToken;
}
export interface GetOpenIdTokenInput {
/**
* A unique identifier in the format REGION:GUID.
*/
IdentityId: IdentityId;
/**
* A set of optional name-value pairs that map provider names to provider tokens. When using graph.facebook.com and www.amazon.com, supply the access_token returned from the provider's authflow. For accounts.google.com, an Amazon Cognito user pool provider, or any other OpenId Connect provider, always include the id_token.
*/
Logins?: LoginsMap;
}
export interface GetOpenIdTokenResponse {
/**
* A unique identifier in the format REGION:GUID. Note that the IdentityId returned may not match the one passed on input.
*/
IdentityId?: IdentityId;
/**
* An OpenID token, valid for 10 minutes.
*/
Token?: OIDCToken;
}
export type HideDisabled = boolean;
export type IdentitiesList = IdentityDescription[];
export interface IdentityDescription {
/**
* A unique identifier in the format REGION:GUID.
*/
IdentityId?: IdentityId;
/**
* The provider names.
*/
Logins?: LoginsList;
/**
* Date on which the identity was created.
*/
CreationDate?: DateType;
/**
* Date on which the identity was last modified.
*/
LastModifiedDate?: DateType;
}
export type IdentityId = string;
export type IdentityIdList = IdentityId[];
export interface IdentityPool {
/**
* An identity pool ID in the format REGION:GUID.
*/
IdentityPoolId: IdentityPoolId;
/**
* A string that you provide.
*/
IdentityPoolName: IdentityPoolName;
/**
* TRUE if the identity pool supports unauthenticated logins.
*/
AllowUnauthenticatedIdentities: IdentityPoolUnauthenticated;
/**
* Optional key:value pairs mapping provider names to provider app IDs.
*/
SupportedLoginProviders?: IdentityProviders;
/**
* The "domain" by which Cognito will refer to your users.
*/
DeveloperProviderName?: DeveloperProviderName;
/**
* A list of OpendID Connect provider ARNs.
*/
OpenIdConnectProviderARNs?: OIDCProviderList;
/**
* A list representing an Amazon Cognito user pool and its client ID.
*/
CognitoIdentityProviders?: CognitoIdentityProviderList;
/**
* An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
*/
SamlProviderARNs?: SAMLProviderList;
/**
* The tags that are assigned to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
*/
IdentityPoolTags?: IdentityPoolTagsType;
}
export type IdentityPoolId = string;
export type IdentityPoolName = string;
export interface IdentityPoolShortDescription {
/**
* An identity pool ID in the format REGION:GUID.
*/
IdentityPoolId?: IdentityPoolId;
/**
* A string that you provide.
*/
IdentityPoolName?: IdentityPoolName;
}
export type IdentityPoolTagsListType = TagKeysType[];
export type IdentityPoolTagsType = {[key: string]: TagValueType};
export type IdentityPoolUnauthenticated = boolean;
export type IdentityPoolsList = IdentityPoolShortDescription[];
export type IdentityProviderId = string;
export type IdentityProviderName = string;
export type IdentityProviderToken = string;
export type IdentityProviders = {[key: string]: IdentityProviderId};
export interface ListIdentitiesInput {
/**
* An identity pool ID in the format REGION:GUID.
*/
IdentityPoolId: IdentityPoolId;
/**
* The maximum number of identities to return.
*/
MaxResults: QueryLimit;
/**
* A pagination token.
*/
NextToken?: PaginationKey;
/**
* An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.
*/
HideDisabled?: HideDisabled;
}
export interface ListIdentitiesResponse {
/**
* An identity pool ID in the format REGION:GUID.
*/
IdentityPoolId?: IdentityPoolId;
/**
* An object containing a set of identities and associated mappings.
*/
Identities?: IdentitiesList;
/**
* A pagination token.
*/
NextToken?: PaginationKey;
}
export interface ListIdentityPoolsInput {
/**
* The maximum number of identities to return.
*/
MaxResults: QueryLimit;
/**
* A pagination token.
*/
NextToken?: PaginationKey;
}
export interface ListIdentityPoolsResponse {
/**
* The identity pools returned by the ListIdentityPools action.
*/
IdentityPools?: IdentityPoolsList;
/**
* A pagination token.
*/
NextToken?: PaginationKey;
}
export interface ListTagsForResourceInput {
/**
* The Amazon Resource Name (ARN) of the identity pool that the tags are assigned to.
*/
ResourceArn: ARNString;
}
export interface ListTagsForResourceResponse {
/**
* The tags that are assigned to the identity pool.
*/
Tags?: IdentityPoolTagsType;
}
export type LoginsList = IdentityProviderName[];
export type LoginsMap = {[key: string]: IdentityProviderToken};
export interface LookupDeveloperIdentityInput {
/**
* An identity pool ID in the format REGION:GUID.
*/
IdentityPoolId: IdentityPoolId;
/**
* A unique identifier in the format REGION:GUID.
*/
IdentityId?: IdentityId;
/**
* A unique ID used by your backend authentication process to identify a user. Typically, a developer identity provider would issue many developer user identifiers, in keeping with the number of users.
*/
DeveloperUserIdentifier?: DeveloperUserIdentifier;
/**
* The maximum number of identities to return.
*/
MaxResults?: QueryLimit;
/**
* A pagination token. The first call you make will have NextToken set to null. After that the service will return NextToken values as needed. For example, let's say you make a request with MaxResults set to 10, and there are 20 matches in the database. The service will return a pagination token as a part of the response. This token can be used to call the API again and get results starting from the 11th match.
*/
NextToken?: PaginationKey;
}
export interface LookupDeveloperIdentityResponse {
/**
* A unique identifier in the format REGION:GUID.
*/
IdentityId?: IdentityId;
/**
* This is the list of developer user identifiers associated with an identity ID. Cognito supports the association of multiple developer user identifiers with an identity ID.
*/
DeveloperUserIdentifierList?: DeveloperUserIdentifierList;
/**
* A pagination token. The first call you make will have NextToken set to null. After that the service will return NextToken values as needed. For example, let's say you make a request with MaxResults set to 10, and there are 20 matches in the database. The service will return a pagination token as a part of the response. This token can be used to call the API again and get results starting from the 11th match.
*/
NextToken?: PaginationKey;
}
export interface MappingRule {
/**
* The claim name that must be present in the token, for example, "isAdmin" or "paid".
*/
Claim: ClaimName;
/**
* The match condition that specifies how closely the claim value in the IdP token must match Value.
*/
MatchType: MappingRuleMatchType;
/**
* A brief string that the claim must match, for example, "paid" or "yes".
*/
Value: ClaimValue;
/**
* The role ARN.
*/
RoleARN: ARNString;
}
export type MappingRuleMatchType = "Equals"|"Contains"|"StartsWith"|"NotEqual"|string;
export type MappingRulesList = MappingRule[];
export interface MergeDeveloperIdentitiesInput {
/**
* User identifier for the source user. The value should be a DeveloperUserIdentifier.
*/
SourceUserIdentifier: DeveloperUserIdentifier;
/**
* User identifier for the destination user. The value should be a DeveloperUserIdentifier.
*/
DestinationUserIdentifier: DeveloperUserIdentifier;
/**
* The "domain" by which Cognito will refer to your users. This is a (pseudo) domain name that you provide while creating an identity pool. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName, you can use letters as well as period (.), underscore (_), and dash (-).
*/
DeveloperProviderName: DeveloperProviderName;
/**
* An identity pool ID in the format REGION:GUID.
*/
IdentityPoolId: IdentityPoolId;
}
export interface MergeDeveloperIdentitiesResponse {
/**
* A unique identifier in the format REGION:GUID.
*/
IdentityId?: IdentityId;
}
export type OIDCProviderList = ARNString[];
export type OIDCToken = string;
export type PaginationKey = string;
export type QueryLimit = number;
export interface RoleMapping {
/**
* The role mapping type. Token will use cognito:roles and cognito:preferred_role claims from the Cognito identity provider token to map groups to roles. Rules will attempt to match claims from the token to map to a role.
*/
Type: RoleMappingType;
/**
* If you specify Token or Rules as the Type, AmbiguousRoleResolution is required. Specifies the action to be taken if either no rules match the claim value for the Rules type, or there is no cognito:preferred_role claim and there are multiple cognito:roles matches for the Token type.
*/
AmbiguousRoleResolution?: AmbiguousRoleResolutionType;
/**
* The rules to be used for mapping users to roles. If you specify Rules as the role mapping type, RulesConfiguration is required.
*/
RulesConfiguration?: RulesConfigurationType;
}
export type RoleMappingMap = {[key: string]: RoleMapping};
export type RoleMappingType = "Token"|"Rules"|string;
export type RoleType = string;
export type RolesMap = {[key: string]: ARNString};
export interface RulesConfigurationType {
/**
* An array of rules. You can specify up to 25 rules per identity provider. Rules are evaluated in order. The first one to match specifies the role.
*/
Rules: MappingRulesList;
}
export type SAMLProviderList = ARNString[];
export type SecretKeyString = string;
export type SessionTokenString = string;
export interface SetIdentityPoolRolesInput {
/**
* An identity pool ID in the format REGION:GUID.
*/
IdentityPoolId: IdentityPoolId;
/**
* The map of roles associated with this pool. For a given role, the key will be either "authenticated" or "unauthenticated" and the value will be the Role ARN.
*/
Roles: RolesMap;
/**
* How users for a specific identity provider are to mapped to roles. This is a string to RoleMapping object map. The string identifies the identity provider, for example, "graph.facebook.com" or "cognito-idp-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id". Up to 25 rules can be specified per identity provider.
*/
RoleMappings?: RoleMappingMap;
}
export type TagKeysType = string;
export interface TagResourceInput {
/**
* The Amazon Resource Name (ARN) of the identity pool to assign the tags to.
*/
ResourceArn: ARNString;
/**
* The tags to assign to the identity pool.
*/
Tags?: IdentityPoolTagsType;
}
export interface TagResourceResponse {
}
export type TagValueType = string;
export type TokenDuration = number;
export interface UnlinkDeveloperIdentityInput {
/**
* A unique identifier in the format REGION:GUID.
*/
IdentityId: IdentityId;
/**
* An identity pool ID in the format REGION:GUID.
*/
IdentityPoolId: IdentityPoolId;
/**
* The "domain" by which Cognito will refer to your users.
*/
DeveloperProviderName: DeveloperProviderName;
/**
* A unique ID used by your backend authentication process to identify a user.
*/
DeveloperUserIdentifier: DeveloperUserIdentifier;
}
export interface UnlinkIdentityInput {
/**
* A unique identifier in the format REGION:GUID.
*/
IdentityId: IdentityId;
/**
* A set of optional name-value pairs that map provider names to provider tokens.
*/
Logins: LoginsMap;
/**
* Provider names to unlink from this identity.
*/
LoginsToRemove: LoginsList;
}
export interface UnprocessedIdentityId {
/**
* A unique identifier in the format REGION:GUID.
*/
IdentityId?: IdentityId;
/**
* The error code indicating the type of error that occurred.
*/
ErrorCode?: ErrorCode;
}
export type UnprocessedIdentityIdList = UnprocessedIdentityId[];
export interface UntagResourceInput {
/**
* The Amazon Resource Name (ARN) of the identity pool that the tags are assigned to.
*/
ResourceArn: ARNString;
/**
* The keys of the tags to remove from the user pool.
*/
TagKeys?: IdentityPoolTagsListType;
}
export interface UntagResourceResponse {
}
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2014-06-30"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the CognitoIdentity client.
*/
export import Types = CognitoIdentity;
}
export = CognitoIdentity;
Reference in New Issue View Git Blame Copy Permalink