/*
* Copyright 2010-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the cognito-identity-2014-06-30.normal.json service model.
*/
using System;
using System.Collections.Generic;
using Amazon.Runtime;
using Amazon.CognitoIdentity.Model;
namespace Amazon.CognitoIdentity
{
///
/// Interface for accessing CognitoIdentity
///
/// Amazon Cognito Federated Identities
///
/// Amazon Cognito Federated Identities is a web service that delivers scoped temporary
/// credentials to mobile devices and other untrusted environments. It uniquely identifies
/// a device and supplies the user with a consistent identity over the lifetime of an
/// application.
///
///
///
/// Using Amazon Cognito Federated Identities, you can enable authentication with one
/// or more third-party identity providers (Facebook, Google, or Login with Amazon) or
/// an Amazon Cognito user pool, and you can also choose to support unauthenticated access
/// from your app. Cognito delivers a unique identifier for each user and acts as an OpenID
/// token provider trusted by AWS Security Token Service (STS) to access temporary, limited-privilege
/// AWS credentials.
///
///
///
/// For a description of the authentication flow from the Amazon Cognito Developer Guide
/// see Authentication
/// Flow.
///
///
///
/// For more information see Amazon
/// Cognito Federated Identities.
///
///
public partial interface IAmazonCognitoIdentity : IAmazonService, IDisposable
{
#region CreateIdentityPool
///
/// Initiates the asynchronous execution of the CreateIdentityPool operation.
///
///
/// Container for the necessary parameters to execute the CreateIdentityPool operation on AmazonCognitoIdentityClient.
/// An Action delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
/// REST API Reference for CreateIdentityPool Operation
void CreateIdentityPoolAsync(CreateIdentityPoolRequest request, AmazonServiceCallback callback, AsyncOptions options = null);
#endregion
#region DeleteIdentities
///
/// Initiates the asynchronous execution of the DeleteIdentities operation.
///
///
/// Container for the necessary parameters to execute the DeleteIdentities operation on AmazonCognitoIdentityClient.
/// An Action delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
/// REST API Reference for DeleteIdentities Operation
void DeleteIdentitiesAsync(DeleteIdentitiesRequest request, AmazonServiceCallback callback, AsyncOptions options = null);
#endregion
#region DeleteIdentityPool
///
/// 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.
///
///
/// An identity pool ID in the format REGION:GUID.
/// An Action delegate that is invoked when the operation completes.
///
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
///
/// The response from the DeleteIdentityPool service method, as returned by CognitoIdentity.
///
/// Thrown when the service encounters an error during processing the request.
///
///
/// Thrown for missing or bad input parameter(s).
///
///
/// Thrown when a user is not authorized to access the requested resource.
///
///
/// Thrown when the requested resource (for example, a dataset or record) does not exist.
///
///
/// Thrown when a request is throttled.
///
/// REST API Reference for DeleteIdentityPool Operation
void DeleteIdentityPoolAsync(string identityPoolId, AmazonServiceCallback callback, AsyncOptions options = null);
///
/// Initiates the asynchronous execution of the DeleteIdentityPool operation.
///
///
/// Container for the necessary parameters to execute the DeleteIdentityPool operation on AmazonCognitoIdentityClient.
/// An Action delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
/// REST API Reference for DeleteIdentityPool Operation
void DeleteIdentityPoolAsync(DeleteIdentityPoolRequest request, AmazonServiceCallback callback, AsyncOptions options = null);
#endregion
#region DescribeIdentity
///
/// 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.
///
///
/// A unique identifier in the format REGION:GUID.
/// An Action delegate that is invoked when the operation completes.
///
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
///
/// The response from the DescribeIdentity service method, as returned by CognitoIdentity.
///
/// Thrown when the service encounters an error during processing the request.
///
///
/// Thrown for missing or bad input parameter(s).
///
///
/// Thrown when a user is not authorized to access the requested resource.
///
///
/// Thrown when the requested resource (for example, a dataset or record) does not exist.
///
///
/// Thrown when a request is throttled.
///
/// REST API Reference for DescribeIdentity Operation
void DescribeIdentityAsync(string identityId, AmazonServiceCallback callback, AsyncOptions options = null);
///
/// Initiates the asynchronous execution of the DescribeIdentity operation.
///
///
/// Container for the necessary parameters to execute the DescribeIdentity operation on AmazonCognitoIdentityClient.
/// An Action delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
/// REST API Reference for DescribeIdentity Operation
void DescribeIdentityAsync(DescribeIdentityRequest request, AmazonServiceCallback callback, AsyncOptions options = null);
#endregion
#region DescribeIdentityPool
///
/// 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.
///
///
/// An identity pool ID in the format REGION:GUID.
/// An Action delegate that is invoked when the operation completes.
///
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
///
/// The response from the DescribeIdentityPool service method, as returned by CognitoIdentity.
///
/// Thrown when the service encounters an error during processing the request.
///
///
/// Thrown for missing or bad input parameter(s).
///
///
/// Thrown when a user is not authorized to access the requested resource.
///
///
/// Thrown when the requested resource (for example, a dataset or record) does not exist.
///
///
/// Thrown when a request is throttled.
///
/// REST API Reference for DescribeIdentityPool Operation
void DescribeIdentityPoolAsync(string identityPoolId, AmazonServiceCallback callback, AsyncOptions options = null);
///
/// Initiates the asynchronous execution of the DescribeIdentityPool operation.
///
///
/// Container for the necessary parameters to execute the DescribeIdentityPool operation on AmazonCognitoIdentityClient.
/// An Action delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
/// REST API Reference for DescribeIdentityPool Operation
void DescribeIdentityPoolAsync(DescribeIdentityPoolRequest request, AmazonServiceCallback callback, AsyncOptions options = null);
#endregion
#region GetCredentialsForIdentity
///
/// 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.
///
///
/// A unique identifier in the format REGION:GUID.
/// An Action delegate that is invoked when the operation completes.
///
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
///
/// The response from the GetCredentialsForIdentity service method, as returned by CognitoIdentity.
///
/// An exception thrown when a dependent service such as Facebook or Twitter is not responding
///
///
/// Thrown when the service encounters an error during processing the request.
///
///
/// Thrown if the identity pool has no role associated for the given auth type (auth/unauth)
/// or if the AssumeRole fails.
///
///
/// Thrown for missing or bad input parameter(s).
///
///
/// Thrown when a user is not authorized to access the requested resource.
///
///
/// Thrown when a user tries to use a login which is already linked to another account.
///
///
/// Thrown when the requested resource (for example, a dataset or record) does not exist.
///
///
/// Thrown when a request is throttled.
///
/// REST API Reference for GetCredentialsForIdentity Operation
void GetCredentialsForIdentityAsync(string identityId, AmazonServiceCallback callback, AsyncOptions options = null);
///
/// 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.
///
///
/// A unique identifier in the format REGION:GUID.
/// 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.
/// An Action delegate that is invoked when the operation completes.
///
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
///
/// The response from the GetCredentialsForIdentity service method, as returned by CognitoIdentity.
///
/// An exception thrown when a dependent service such as Facebook or Twitter is not responding
///
///
/// Thrown when the service encounters an error during processing the request.
///
///
/// Thrown if the identity pool has no role associated for the given auth type (auth/unauth)
/// or if the AssumeRole fails.
///
///
/// Thrown for missing or bad input parameter(s).
///
///
/// Thrown when a user is not authorized to access the requested resource.
///
///
/// Thrown when a user tries to use a login which is already linked to another account.
///
///
/// Thrown when the requested resource (for example, a dataset or record) does not exist.
///
///
/// Thrown when a request is throttled.
///
/// REST API Reference for GetCredentialsForIdentity Operation
void GetCredentialsForIdentityAsync(string identityId, Dictionary logins, AmazonServiceCallback callback, AsyncOptions options = null);
///
/// Initiates the asynchronous execution of the GetCredentialsForIdentity operation.
///
///
/// Container for the necessary parameters to execute the GetCredentialsForIdentity operation on AmazonCognitoIdentityClient.
/// An Action delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
/// REST API Reference for GetCredentialsForIdentity Operation
void GetCredentialsForIdentityAsync(GetCredentialsForIdentityRequest request, AmazonServiceCallback callback, AsyncOptions options = null);
#endregion
#region GetId
///
/// Initiates the asynchronous execution of the GetId operation.
///
///
/// Container for the necessary parameters to execute the GetId operation on AmazonCognitoIdentityClient.
/// An Action delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
/// REST API Reference for GetId Operation
void GetIdAsync(GetIdRequest request, AmazonServiceCallback callback, AsyncOptions options = null);
#endregion
#region GetIdentityPoolRoles
///
/// Gets the roles for an identity pool.
///
///
///
/// You must use AWS Developer credentials to call this API.
///
///
/// An identity pool ID in the format REGION:GUID.
/// An Action delegate that is invoked when the operation completes.
///
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
///
/// The response from the GetIdentityPoolRoles service method, as returned by CognitoIdentity.
///
/// Thrown when the service encounters an error during processing the request.
///
///
/// Thrown for missing or bad input parameter(s).
///
///
/// Thrown when a user is not authorized to access the requested resource.
///
///
/// Thrown when a user tries to use a login which is already linked to another account.
///
///
/// Thrown when the requested resource (for example, a dataset or record) does not exist.
///
///
/// Thrown when a request is throttled.
///
/// REST API Reference for GetIdentityPoolRoles Operation
void GetIdentityPoolRolesAsync(string identityPoolId, AmazonServiceCallback callback, AsyncOptions options = null);
///
/// Initiates the asynchronous execution of the GetIdentityPoolRoles operation.
///
///
/// Container for the necessary parameters to execute the GetIdentityPoolRoles operation on AmazonCognitoIdentityClient.
/// An Action delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
/// REST API Reference for GetIdentityPoolRoles Operation
void GetIdentityPoolRolesAsync(GetIdentityPoolRolesRequest request, AmazonServiceCallback callback, AsyncOptions options = null);
#endregion
#region GetOpenIdToken
///
/// 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.
///
///
/// A unique identifier in the format REGION:GUID.
/// An Action delegate that is invoked when the operation completes.
///
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
///
/// The response from the GetOpenIdToken service method, as returned by CognitoIdentity.
///
/// An exception thrown when a dependent service such as Facebook or Twitter is not responding
///
///
/// Thrown when the service encounters an error during processing the request.
///
///
/// Thrown for missing or bad input parameter(s).
///
///
/// Thrown when a user is not authorized to access the requested resource.
///
///
/// Thrown when a user tries to use a login which is already linked to another account.
///
///
/// Thrown when the requested resource (for example, a dataset or record) does not exist.
///
///
/// Thrown when a request is throttled.
///
/// REST API Reference for GetOpenIdToken Operation
void GetOpenIdTokenAsync(string identityId, AmazonServiceCallback callback, AsyncOptions options = null);
///
/// Initiates the asynchronous execution of the GetOpenIdToken operation.
///
///
/// Container for the necessary parameters to execute the GetOpenIdToken operation on AmazonCognitoIdentityClient.
/// An Action delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
/// REST API Reference for GetOpenIdToken Operation
void GetOpenIdTokenAsync(GetOpenIdTokenRequest request, AmazonServiceCallback callback, AsyncOptions options = null);
#endregion
#region GetOpenIdTokenForDeveloperIdentity
///
/// Initiates the asynchronous execution of the GetOpenIdTokenForDeveloperIdentity operation.
///
///
/// Container for the necessary parameters to execute the GetOpenIdTokenForDeveloperIdentity operation on AmazonCognitoIdentityClient.
/// An Action delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
/// REST API Reference for GetOpenIdTokenForDeveloperIdentity Operation
void GetOpenIdTokenForDeveloperIdentityAsync(GetOpenIdTokenForDeveloperIdentityRequest request, AmazonServiceCallback callback, AsyncOptions options = null);
#endregion
#region ListIdentities
///
/// Initiates the asynchronous execution of the ListIdentities operation.
///
///
/// Container for the necessary parameters to execute the ListIdentities operation on AmazonCognitoIdentityClient.
/// An Action delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
/// REST API Reference for ListIdentities Operation
void ListIdentitiesAsync(ListIdentitiesRequest request, AmazonServiceCallback callback, AsyncOptions options = null);
#endregion
#region ListIdentityPools
///
/// Initiates the asynchronous execution of the ListIdentityPools operation.
///
///
/// Container for the necessary parameters to execute the ListIdentityPools operation on AmazonCognitoIdentityClient.
/// An Action delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
/// REST API Reference for ListIdentityPools Operation
void ListIdentityPoolsAsync(ListIdentityPoolsRequest request, AmazonServiceCallback callback, AsyncOptions options = null);
#endregion
#region ListTagsForResource
///
/// Initiates the asynchronous execution of the ListTagsForResource operation.
///
///
/// Container for the necessary parameters to execute the ListTagsForResource operation on AmazonCognitoIdentityClient.
/// An Action delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
/// REST API Reference for ListTagsForResource Operation
void ListTagsForResourceAsync(ListTagsForResourceRequest request, AmazonServiceCallback callback, AsyncOptions options = null);
#endregion
#region LookupDeveloperIdentity
///
/// Initiates the asynchronous execution of the LookupDeveloperIdentity operation.
///
///
/// Container for the necessary parameters to execute the LookupDeveloperIdentity operation on AmazonCognitoIdentityClient.
/// An Action delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
/// REST API Reference for LookupDeveloperIdentity Operation
void LookupDeveloperIdentityAsync(LookupDeveloperIdentityRequest request, AmazonServiceCallback callback, AsyncOptions options = null);
#endregion
#region MergeDeveloperIdentities
///
/// Initiates the asynchronous execution of the MergeDeveloperIdentities operation.
///
///
/// Container for the necessary parameters to execute the MergeDeveloperIdentities operation on AmazonCognitoIdentityClient.
/// An Action delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
/// REST API Reference for MergeDeveloperIdentities Operation
void MergeDeveloperIdentitiesAsync(MergeDeveloperIdentitiesRequest request, AmazonServiceCallback callback, AsyncOptions options = null);
#endregion
#region SetIdentityPoolRoles
///
/// 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.
///
///
/// An identity pool ID in the format REGION:GUID.
/// 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.
/// An Action delegate that is invoked when the operation completes.
///
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
///
/// The response from the SetIdentityPoolRoles service method, as returned by CognitoIdentity.
///
/// Thrown if there are parallel requests to modify a resource.
///
///
/// Thrown when the service encounters an error during processing the request.
///
///
/// Thrown for missing or bad input parameter(s).
///
///
/// Thrown when a user is not authorized to access the requested resource.
///
///
/// Thrown when a user tries to use a login which is already linked to another account.
///
///
/// Thrown when the requested resource (for example, a dataset or record) does not exist.
///
///
/// Thrown when a request is throttled.
///
/// REST API Reference for SetIdentityPoolRoles Operation
void SetIdentityPoolRolesAsync(string identityPoolId, Dictionary roles, AmazonServiceCallback callback, AsyncOptions options = null);
///
/// Initiates the asynchronous execution of the SetIdentityPoolRoles operation.
///
///
/// Container for the necessary parameters to execute the SetIdentityPoolRoles operation on AmazonCognitoIdentityClient.
/// An Action delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
/// REST API Reference for SetIdentityPoolRoles Operation
void SetIdentityPoolRolesAsync(SetIdentityPoolRolesRequest request, AmazonServiceCallback callback, AsyncOptions options = null);
#endregion
#region TagResource
///
/// Initiates the asynchronous execution of the TagResource operation.
///
///
/// Container for the necessary parameters to execute the TagResource operation on AmazonCognitoIdentityClient.
/// An Action delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
/// REST API Reference for TagResource Operation
void TagResourceAsync(TagResourceRequest request, AmazonServiceCallback callback, AsyncOptions options = null);
#endregion
#region UnlinkDeveloperIdentity
///
/// Initiates the asynchronous execution of the UnlinkDeveloperIdentity operation.
///
///
/// Container for the necessary parameters to execute the UnlinkDeveloperIdentity operation on AmazonCognitoIdentityClient.
/// An Action delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
/// REST API Reference for UnlinkDeveloperIdentity Operation
void UnlinkDeveloperIdentityAsync(UnlinkDeveloperIdentityRequest request, AmazonServiceCallback callback, AsyncOptions options = null);
#endregion
#region UnlinkIdentity
///
/// Initiates the asynchronous execution of the UnlinkIdentity operation.
///
///
/// Container for the necessary parameters to execute the UnlinkIdentity operation on AmazonCognitoIdentityClient.
/// An Action delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
/// REST API Reference for UnlinkIdentity Operation
void UnlinkIdentityAsync(UnlinkIdentityRequest request, AmazonServiceCallback callback, AsyncOptions options = null);
#endregion
#region UntagResource
///
/// Initiates the asynchronous execution of the UntagResource operation.
///
///
/// Container for the necessary parameters to execute the UntagResource operation on AmazonCognitoIdentityClient.
/// An Action delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
/// REST API Reference for UntagResource Operation
void UntagResourceAsync(UntagResourceRequest request, AmazonServiceCallback callback, AsyncOptions options = null);
#endregion
#region UpdateIdentityPool
///
/// Initiates the asynchronous execution of the UpdateIdentityPool operation.
///
///
/// Container for the necessary parameters to execute the UpdateIdentityPool operation on AmazonCognitoIdentityClient.
/// An Action delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
/// REST API Reference for UpdateIdentityPool Operation
void UpdateIdentityPoolAsync(UpdateIdentityPoolRequest request, AmazonServiceCallback callback, AsyncOptions options = null);
#endregion
}
}