/*
* Copyright 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.Runtime.ExceptionServices;
using System.Threading;
using System.Threading.Tasks;
using System.Collections.Generic;
using System.Net;
using Amazon.CognitoIdentity.Model;
using Amazon.CognitoIdentity.Model.Internal.MarshallTransformations;
using Amazon.CognitoIdentity.Internal;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
using Amazon.Runtime.Internal.Auth;
using Amazon.Runtime.Internal.Transform;
namespace Amazon.CognitoIdentity
{
///
/// Implementation 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 class AmazonCognitoIdentityClient : AmazonServiceClient, IAmazonCognitoIdentity
{
private static IServiceMetadata serviceMetadata = new AmazonCognitoIdentityMetadata();
private ICognitoIdentityPaginatorFactory _paginators;
///
/// Paginators for the service
///
public ICognitoIdentityPaginatorFactory Paginators
{
get
{
if (this._paginators == null)
{
this._paginators = new CognitoIdentityPaginatorFactory(this);
}
return this._paginators;
}
}
#region Constructors
///
/// Constructs AmazonCognitoIdentityClient with the credentials loaded from the application's
/// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
///
/// Example App.config with credentials set.
///
/// <?xml version="1.0" encoding="utf-8" ?>
/// <configuration>
/// <appSettings>
/// <add key="AWSProfileName" value="AWS Default"/>
/// </appSettings>
/// </configuration>
///
///
///
public AmazonCognitoIdentityClient()
: base(FallbackCredentialsFactory.GetCredentials(), new AmazonCognitoIdentityConfig()) { }
///
/// Constructs AmazonCognitoIdentityClient with the credentials loaded from the application's
/// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
///
/// Example App.config with credentials set.
///
/// <?xml version="1.0" encoding="utf-8" ?>
/// <configuration>
/// <appSettings>
/// <add key="AWSProfileName" value="AWS Default"/>
/// </appSettings>
/// </configuration>
///
///
///
/// The region to connect.
public AmazonCognitoIdentityClient(RegionEndpoint region)
: base(FallbackCredentialsFactory.GetCredentials(), new AmazonCognitoIdentityConfig{RegionEndpoint = region}) { }
///
/// Constructs AmazonCognitoIdentityClient with the credentials loaded from the application's
/// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
///
/// Example App.config with credentials set.
///
/// <?xml version="1.0" encoding="utf-8" ?>
/// <configuration>
/// <appSettings>
/// <add key="AWSProfileName" value="AWS Default"/>
/// </appSettings>
/// </configuration>
///
///
///
/// The AmazonCognitoIdentityClient Configuration Object
public AmazonCognitoIdentityClient(AmazonCognitoIdentityConfig config)
: base(FallbackCredentialsFactory.GetCredentials(config), config){}
///
/// Constructs AmazonCognitoIdentityClient with AWS Credentials
///
/// AWS Credentials
public AmazonCognitoIdentityClient(AWSCredentials credentials)
: this(credentials, new AmazonCognitoIdentityConfig())
{
}
///
/// Constructs AmazonCognitoIdentityClient with AWS Credentials
///
/// AWS Credentials
/// The region to connect.
public AmazonCognitoIdentityClient(AWSCredentials credentials, RegionEndpoint region)
: this(credentials, new AmazonCognitoIdentityConfig{RegionEndpoint = region})
{
}
///
/// Constructs AmazonCognitoIdentityClient with AWS Credentials and an
/// AmazonCognitoIdentityClient Configuration object.
///
/// AWS Credentials
/// The AmazonCognitoIdentityClient Configuration Object
public AmazonCognitoIdentityClient(AWSCredentials credentials, AmazonCognitoIdentityConfig clientConfig)
: base(credentials, clientConfig)
{
}
///
/// Constructs AmazonCognitoIdentityClient with AWS Access Key ID and AWS Secret Key
///
/// AWS Access Key ID
/// AWS Secret Access Key
public AmazonCognitoIdentityClient(string awsAccessKeyId, string awsSecretAccessKey)
: this(awsAccessKeyId, awsSecretAccessKey, new AmazonCognitoIdentityConfig())
{
}
///
/// Constructs AmazonCognitoIdentityClient with AWS Access Key ID and AWS Secret Key
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// The region to connect.
public AmazonCognitoIdentityClient(string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region)
: this(awsAccessKeyId, awsSecretAccessKey, new AmazonCognitoIdentityConfig() {RegionEndpoint=region})
{
}
///
/// Constructs AmazonCognitoIdentityClient with AWS Access Key ID, AWS Secret Key and an
/// AmazonCognitoIdentityClient Configuration object.
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// The AmazonCognitoIdentityClient Configuration Object
public AmazonCognitoIdentityClient(string awsAccessKeyId, string awsSecretAccessKey, AmazonCognitoIdentityConfig clientConfig)
: base(awsAccessKeyId, awsSecretAccessKey, clientConfig)
{
}
///
/// Constructs AmazonCognitoIdentityClient with AWS Access Key ID and AWS Secret Key
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// AWS Session Token
public AmazonCognitoIdentityClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken)
: this(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, new AmazonCognitoIdentityConfig())
{
}
///
/// Constructs AmazonCognitoIdentityClient with AWS Access Key ID and AWS Secret Key
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// AWS Session Token
/// The region to connect.
public AmazonCognitoIdentityClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region)
: this(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, new AmazonCognitoIdentityConfig{RegionEndpoint = region})
{
}
///
/// Constructs AmazonCognitoIdentityClient with AWS Access Key ID, AWS Secret Key and an
/// AmazonCognitoIdentityClient Configuration object.
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// AWS Session Token
/// The AmazonCognitoIdentityClient Configuration Object
public AmazonCognitoIdentityClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonCognitoIdentityConfig clientConfig)
: base(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, clientConfig)
{
}
#endregion
#region Overrides
///
/// Creates the signer for the service.
///
protected override AbstractAWSSigner CreateSigner()
{
return new AWS4Signer();
}
///
/// Customize the pipeline
///
///
protected override void CustomizeRuntimePipeline(RuntimePipeline pipeline)
{
pipeline.RemoveHandler();
pipeline.AddHandlerAfter(new AmazonCognitoIdentityEndpointResolver());
}
///
/// Capture metadata for the service.
///
protected override IServiceMetadata ServiceMetadata
{
get
{
return serviceMetadata;
}
}
#endregion
#region Dispose
///
/// Disposes the service client.
///
protected override void Dispose(bool disposing)
{
base.Dispose(disposing);
}
#endregion
#region CreateIdentityPool
///
/// 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.
///
///
/// Container for the necessary parameters to execute the CreateIdentityPool service method.
///
/// The response from the CreateIdentityPool 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 the total number of user pools has exceeded a preset limit.
///
///
/// 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 a request is throttled.
///
/// REST API Reference for CreateIdentityPool Operation
public virtual CreateIdentityPoolResponse CreateIdentityPool(CreateIdentityPoolRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateIdentityPoolRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateIdentityPoolResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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.
///
///
/// Container for the necessary parameters to execute the CreateIdentityPool service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateIdentityPool 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 the total number of user pools has exceeded a preset limit.
///
///
/// 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 a request is throttled.
///
/// REST API Reference for CreateIdentityPool Operation
public virtual Task CreateIdentityPoolAsync(CreateIdentityPoolRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateIdentityPoolRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateIdentityPoolResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DeleteIdentities
///
/// 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.
///
///
/// Container for the necessary parameters to execute the DeleteIdentities service method.
///
/// The response from the DeleteIdentities 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 request is throttled.
///
/// REST API Reference for DeleteIdentities Operation
public virtual DeleteIdentitiesResponse DeleteIdentities(DeleteIdentitiesRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteIdentitiesRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteIdentitiesResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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.
///
///
/// Container for the necessary parameters to execute the DeleteIdentities service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteIdentities 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 request is throttled.
///
/// REST API Reference for DeleteIdentities Operation
public virtual Task DeleteIdentitiesAsync(DeleteIdentitiesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteIdentitiesRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteIdentitiesResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#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.
///
/// 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
public virtual DeleteIdentityPoolResponse DeleteIdentityPool(string identityPoolId)
{
var request = new DeleteIdentityPoolRequest();
request.IdentityPoolId = identityPoolId;
return DeleteIdentityPool(request);
}
///
/// 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.
///
///
/// Container for the necessary parameters to execute the DeleteIdentityPool service method.
///
/// 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
public virtual DeleteIdentityPoolResponse DeleteIdentityPool(DeleteIdentityPoolRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteIdentityPoolRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteIdentityPoolResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
public virtual Task DeleteIdentityPoolAsync(string identityPoolId, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new DeleteIdentityPoolRequest();
request.IdentityPoolId = identityPoolId;
return DeleteIdentityPoolAsync(request, cancellationToken);
}
///
/// 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.
///
///
/// Container for the necessary parameters to execute the DeleteIdentityPool service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
public virtual Task DeleteIdentityPoolAsync(DeleteIdentityPoolRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteIdentityPoolRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteIdentityPoolResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#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.
///
/// 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
public virtual DescribeIdentityResponse DescribeIdentity(string identityId)
{
var request = new DescribeIdentityRequest();
request.IdentityId = identityId;
return DescribeIdentity(request);
}
///
/// 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.
///
///
/// Container for the necessary parameters to execute the DescribeIdentity service method.
///
/// 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
public virtual DescribeIdentityResponse DescribeIdentity(DescribeIdentityRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeIdentityRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeIdentityResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
public virtual Task DescribeIdentityAsync(string identityId, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new DescribeIdentityRequest();
request.IdentityId = identityId;
return DescribeIdentityAsync(request, cancellationToken);
}
///
/// 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.
///
///
/// Container for the necessary parameters to execute the DescribeIdentity service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
public virtual Task DescribeIdentityAsync(DescribeIdentityRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeIdentityRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeIdentityResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#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.
///
/// 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
public virtual DescribeIdentityPoolResponse DescribeIdentityPool(string identityPoolId)
{
var request = new DescribeIdentityPoolRequest();
request.IdentityPoolId = identityPoolId;
return DescribeIdentityPool(request);
}
///
/// 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.
///
///
/// Container for the necessary parameters to execute the DescribeIdentityPool service method.
///
/// 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
public virtual DescribeIdentityPoolResponse DescribeIdentityPool(DescribeIdentityPoolRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeIdentityPoolRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeIdentityPoolResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
public virtual Task DescribeIdentityPoolAsync(string identityPoolId, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new DescribeIdentityPoolRequest();
request.IdentityPoolId = identityPoolId;
return DescribeIdentityPoolAsync(request, cancellationToken);
}
///
/// 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.
///
///
/// Container for the necessary parameters to execute the DescribeIdentityPool service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
public virtual Task DescribeIdentityPoolAsync(DescribeIdentityPoolRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeIdentityPoolRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeIdentityPoolResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#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.
///
/// 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
public virtual GetCredentialsForIdentityResponse GetCredentialsForIdentity(string identityId)
{
var request = new GetCredentialsForIdentityRequest();
request.IdentityId = identityId;
return GetCredentialsForIdentity(request);
}
///
/// 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.
///
/// 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
public virtual GetCredentialsForIdentityResponse GetCredentialsForIdentity(string identityId, Dictionary logins)
{
var request = new GetCredentialsForIdentityRequest();
request.IdentityId = identityId;
request.Logins = logins;
return GetCredentialsForIdentity(request);
}
///
/// 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.
///
///
/// Container for the necessary parameters to execute the GetCredentialsForIdentity service method.
///
/// 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
public virtual GetCredentialsForIdentityResponse GetCredentialsForIdentity(GetCredentialsForIdentityRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetCredentialsForIdentityRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetCredentialsForIdentityResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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 cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
public virtual Task GetCredentialsForIdentityAsync(string identityId, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new GetCredentialsForIdentityRequest();
request.IdentityId = identityId;
return GetCredentialsForIdentityAsync(request, cancellationToken);
}
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
public virtual Task GetCredentialsForIdentityAsync(string identityId, Dictionary logins, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new GetCredentialsForIdentityRequest();
request.IdentityId = identityId;
request.Logins = logins;
return GetCredentialsForIdentityAsync(request, cancellationToken);
}
///
/// 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.
///
///
/// Container for the necessary parameters to execute the GetCredentialsForIdentity service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
public virtual Task GetCredentialsForIdentityAsync(GetCredentialsForIdentityRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetCredentialsForIdentityRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetCredentialsForIdentityResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetId
///
/// 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.
///
///
/// Container for the necessary parameters to execute the GetId service method.
///
/// The response from the GetId 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 the total number of user pools has exceeded a preset limit.
///
///
/// 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 GetId Operation
public virtual GetIdResponse GetId(GetIdRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetIdRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetIdResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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.
///
///
/// Container for the necessary parameters to execute the GetId service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetId 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 the total number of user pools has exceeded a preset limit.
///
///
/// 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 GetId Operation
public virtual Task GetIdAsync(GetIdRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetIdRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetIdResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#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.
///
/// 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
public virtual GetIdentityPoolRolesResponse GetIdentityPoolRoles(string identityPoolId)
{
var request = new GetIdentityPoolRolesRequest();
request.IdentityPoolId = identityPoolId;
return GetIdentityPoolRoles(request);
}
///
/// Gets the roles for an identity pool.
///
///
///
/// You must use AWS Developer credentials to call this API.
///
///
/// Container for the necessary parameters to execute the GetIdentityPoolRoles service method.
///
/// 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
public virtual GetIdentityPoolRolesResponse GetIdentityPoolRoles(GetIdentityPoolRolesRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetIdentityPoolRolesRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetIdentityPoolRolesResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
public virtual Task GetIdentityPoolRolesAsync(string identityPoolId, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new GetIdentityPoolRolesRequest();
request.IdentityPoolId = identityPoolId;
return GetIdentityPoolRolesAsync(request, cancellationToken);
}
///
/// Gets the roles for an identity pool.
///
///
///
/// You must use AWS Developer credentials to call this API.
///
///
/// Container for the necessary parameters to execute the GetIdentityPoolRoles service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
public virtual Task GetIdentityPoolRolesAsync(GetIdentityPoolRolesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetIdentityPoolRolesRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetIdentityPoolRolesResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#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.
///
/// 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
public virtual GetOpenIdTokenResponse GetOpenIdToken(string identityId)
{
var request = new GetOpenIdTokenRequest();
request.IdentityId = identityId;
return GetOpenIdToken(request);
}
///
/// 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.
///
///
/// Container for the necessary parameters to execute the GetOpenIdToken service method.
///
/// 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
public virtual GetOpenIdTokenResponse GetOpenIdToken(GetOpenIdTokenRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetOpenIdTokenRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetOpenIdTokenResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
public virtual Task GetOpenIdTokenAsync(string identityId, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new GetOpenIdTokenRequest();
request.IdentityId = identityId;
return GetOpenIdTokenAsync(request, cancellationToken);
}
///
/// 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.
///
///
/// Container for the necessary parameters to execute the GetOpenIdToken service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
public virtual Task GetOpenIdTokenAsync(GetOpenIdTokenRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetOpenIdTokenRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetOpenIdTokenResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetOpenIdTokenForDeveloperIdentity
///
/// 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.
///
///
/// Container for the necessary parameters to execute the GetOpenIdTokenForDeveloperIdentity service method.
///
/// The response from the GetOpenIdTokenForDeveloperIdentity service method, as returned by CognitoIdentity.
///
/// The provided developer user identifier is already registered with Cognito under a
/// different identity ID.
///
///
/// 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 GetOpenIdTokenForDeveloperIdentity Operation
public virtual GetOpenIdTokenForDeveloperIdentityResponse GetOpenIdTokenForDeveloperIdentity(GetOpenIdTokenForDeveloperIdentityRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetOpenIdTokenForDeveloperIdentityRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetOpenIdTokenForDeveloperIdentityResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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.
///
///
/// Container for the necessary parameters to execute the GetOpenIdTokenForDeveloperIdentity service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetOpenIdTokenForDeveloperIdentity service method, as returned by CognitoIdentity.
///
/// The provided developer user identifier is already registered with Cognito under a
/// different identity ID.
///
///
/// 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 GetOpenIdTokenForDeveloperIdentity Operation
public virtual Task GetOpenIdTokenForDeveloperIdentityAsync(GetOpenIdTokenForDeveloperIdentityRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetOpenIdTokenForDeveloperIdentityRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetOpenIdTokenForDeveloperIdentityResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetPrincipalTagAttributeMap
///
/// Use GetPrincipalTagAttributeMap
to list all mappings between PrincipalTags
/// and user attributes.
///
/// Container for the necessary parameters to execute the GetPrincipalTagAttributeMap service method.
///
/// The response from the GetPrincipalTagAttributeMap 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 GetPrincipalTagAttributeMap Operation
public virtual GetPrincipalTagAttributeMapResponse GetPrincipalTagAttributeMap(GetPrincipalTagAttributeMapRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetPrincipalTagAttributeMapRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetPrincipalTagAttributeMapResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Use GetPrincipalTagAttributeMap
to list all mappings between PrincipalTags
/// and user attributes.
///
/// Container for the necessary parameters to execute the GetPrincipalTagAttributeMap service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetPrincipalTagAttributeMap 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 GetPrincipalTagAttributeMap Operation
public virtual Task GetPrincipalTagAttributeMapAsync(GetPrincipalTagAttributeMapRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetPrincipalTagAttributeMapRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetPrincipalTagAttributeMapResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region ListIdentities
///
/// Lists the identities in an identity pool.
///
///
///
/// You must use AWS Developer credentials to call this API.
///
///
/// Container for the necessary parameters to execute the ListIdentities service method.
///
/// The response from the ListIdentities 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 ListIdentities Operation
public virtual ListIdentitiesResponse ListIdentities(ListIdentitiesRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListIdentitiesRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListIdentitiesResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Lists the identities in an identity pool.
///
///
///
/// You must use AWS Developer credentials to call this API.
///
///
/// Container for the necessary parameters to execute the ListIdentities service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListIdentities 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 ListIdentities Operation
public virtual Task ListIdentitiesAsync(ListIdentitiesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListIdentitiesRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListIdentitiesResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region ListIdentityPools
///
/// Lists all of the Cognito identity pools registered for your account.
///
///
///
/// You must use AWS Developer credentials to call this API.
///
///
/// Container for the necessary parameters to execute the ListIdentityPools service method.
///
/// The response from the ListIdentityPools 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 ListIdentityPools Operation
public virtual ListIdentityPoolsResponse ListIdentityPools(ListIdentityPoolsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListIdentityPoolsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListIdentityPoolsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Lists all of the Cognito identity pools registered for your account.
///
///
///
/// You must use AWS Developer credentials to call this API.
///
///
/// Container for the necessary parameters to execute the ListIdentityPools service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListIdentityPools 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 ListIdentityPools Operation
public virtual Task ListIdentityPoolsAsync(ListIdentityPoolsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListIdentityPoolsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListIdentityPoolsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region ListTagsForResource
///
/// 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.
///
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// The response from the ListTagsForResource 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 ListTagsForResource Operation
public virtual ListTagsForResourceResponse ListTagsForResource(ListTagsForResourceRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListTagsForResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListTagsForResourceResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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.
///
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListTagsForResource 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 ListTagsForResource Operation
public virtual Task ListTagsForResourceAsync(ListTagsForResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListTagsForResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListTagsForResourceResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region LookupDeveloperIdentity
///
/// 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.
///
///
/// Container for the necessary parameters to execute the LookupDeveloperIdentity service method.
///
/// The response from the LookupDeveloperIdentity 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 LookupDeveloperIdentity Operation
public virtual LookupDeveloperIdentityResponse LookupDeveloperIdentity(LookupDeveloperIdentityRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = LookupDeveloperIdentityRequestMarshaller.Instance;
options.ResponseUnmarshaller = LookupDeveloperIdentityResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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.
///
///
/// Container for the necessary parameters to execute the LookupDeveloperIdentity service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the LookupDeveloperIdentity 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 LookupDeveloperIdentity Operation
public virtual Task LookupDeveloperIdentityAsync(LookupDeveloperIdentityRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = LookupDeveloperIdentityRequestMarshaller.Instance;
options.ResponseUnmarshaller = LookupDeveloperIdentityResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region MergeDeveloperIdentities
///
/// Merges two users having different IdentityId
s, 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.
///
///
/// Container for the necessary parameters to execute the MergeDeveloperIdentities service method.
///
/// The response from the MergeDeveloperIdentities 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 MergeDeveloperIdentities Operation
public virtual MergeDeveloperIdentitiesResponse MergeDeveloperIdentities(MergeDeveloperIdentitiesRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = MergeDeveloperIdentitiesRequestMarshaller.Instance;
options.ResponseUnmarshaller = MergeDeveloperIdentitiesResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Merges two users having different IdentityId
s, 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.
///
///
/// Container for the necessary parameters to execute the MergeDeveloperIdentities service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the MergeDeveloperIdentities 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 MergeDeveloperIdentities Operation
public virtual Task MergeDeveloperIdentitiesAsync(MergeDeveloperIdentitiesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = MergeDeveloperIdentitiesRequestMarshaller.Instance;
options.ResponseUnmarshaller = MergeDeveloperIdentitiesResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#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.
///
/// 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
public virtual SetIdentityPoolRolesResponse SetIdentityPoolRoles(string identityPoolId, Dictionary roles)
{
var request = new SetIdentityPoolRolesRequest();
request.IdentityPoolId = identityPoolId;
request.Roles = roles;
return SetIdentityPoolRoles(request);
}
///
/// 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.
///
///
/// Container for the necessary parameters to execute the SetIdentityPoolRoles service method.
///
/// 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
public virtual SetIdentityPoolRolesResponse SetIdentityPoolRoles(SetIdentityPoolRolesRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = SetIdentityPoolRolesRequestMarshaller.Instance;
options.ResponseUnmarshaller = SetIdentityPoolRolesResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
public virtual Task SetIdentityPoolRolesAsync(string identityPoolId, Dictionary roles, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new SetIdentityPoolRolesRequest();
request.IdentityPoolId = identityPoolId;
request.Roles = roles;
return SetIdentityPoolRolesAsync(request, cancellationToken);
}
///
/// 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.
///
///
/// Container for the necessary parameters to execute the SetIdentityPoolRoles service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
public virtual Task SetIdentityPoolRolesAsync(SetIdentityPoolRolesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = SetIdentityPoolRolesRequestMarshaller.Instance;
options.ResponseUnmarshaller = SetIdentityPoolRolesResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region SetPrincipalTagAttributeMap
///
/// You can use this operation to use default (username and clientID) attribute or custom
/// attribute mappings.
///
/// Container for the necessary parameters to execute the SetPrincipalTagAttributeMap service method.
///
/// The response from the SetPrincipalTagAttributeMap 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 SetPrincipalTagAttributeMap Operation
public virtual SetPrincipalTagAttributeMapResponse SetPrincipalTagAttributeMap(SetPrincipalTagAttributeMapRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = SetPrincipalTagAttributeMapRequestMarshaller.Instance;
options.ResponseUnmarshaller = SetPrincipalTagAttributeMapResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// You can use this operation to use default (username and clientID) attribute or custom
/// attribute mappings.
///
/// Container for the necessary parameters to execute the SetPrincipalTagAttributeMap service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the SetPrincipalTagAttributeMap 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 SetPrincipalTagAttributeMap Operation
public virtual Task SetPrincipalTagAttributeMapAsync(SetPrincipalTagAttributeMapRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = SetPrincipalTagAttributeMapRequestMarshaller.Instance;
options.ResponseUnmarshaller = SetPrincipalTagAttributeMapResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region TagResource
///
/// 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.
///
///
/// Container for the necessary parameters to execute the TagResource service method.
///
/// The response from the TagResource 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 TagResource Operation
public virtual TagResourceResponse TagResource(TagResourceRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = TagResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = TagResourceResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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.
///
///
/// Container for the necessary parameters to execute the TagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the TagResource 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 TagResource Operation
public virtual Task TagResourceAsync(TagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = TagResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = TagResourceResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region UnlinkDeveloperIdentity
///
/// 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.
///
///
/// Container for the necessary parameters to execute the UnlinkDeveloperIdentity service method.
///
/// The response from the UnlinkDeveloperIdentity 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 UnlinkDeveloperIdentity Operation
public virtual UnlinkDeveloperIdentityResponse UnlinkDeveloperIdentity(UnlinkDeveloperIdentityRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = UnlinkDeveloperIdentityRequestMarshaller.Instance;
options.ResponseUnmarshaller = UnlinkDeveloperIdentityResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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.
///
///
/// Container for the necessary parameters to execute the UnlinkDeveloperIdentity service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UnlinkDeveloperIdentity 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 UnlinkDeveloperIdentity Operation
public virtual Task UnlinkDeveloperIdentityAsync(UnlinkDeveloperIdentityRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = UnlinkDeveloperIdentityRequestMarshaller.Instance;
options.ResponseUnmarshaller = UnlinkDeveloperIdentityResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region UnlinkIdentity
///
/// 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.
///
///
/// Container for the necessary parameters to execute the UnlinkIdentity service method.
///
/// The response from the UnlinkIdentity 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 UnlinkIdentity Operation
public virtual UnlinkIdentityResponse UnlinkIdentity(UnlinkIdentityRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = UnlinkIdentityRequestMarshaller.Instance;
options.ResponseUnmarshaller = UnlinkIdentityResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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.
///
///
/// Container for the necessary parameters to execute the UnlinkIdentity service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UnlinkIdentity 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 UnlinkIdentity Operation
public virtual Task UnlinkIdentityAsync(UnlinkIdentityRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = UnlinkIdentityRequestMarshaller.Instance;
options.ResponseUnmarshaller = UnlinkIdentityResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region UntagResource
///
/// Removes the specified tags from the specified Amazon Cognito identity pool. You can
/// use this action up to 5 times per second, per account
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// The response from the UntagResource 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 UntagResource Operation
public virtual UntagResourceResponse UntagResource(UntagResourceRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = UntagResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = UntagResourceResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Removes the specified tags from the specified Amazon Cognito identity pool. You can
/// use this action up to 5 times per second, per account
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UntagResource 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 UntagResource Operation
public virtual Task UntagResourceAsync(UntagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = UntagResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = UntagResourceResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region UpdateIdentityPool
///
/// Updates an identity pool.
///
///
///
/// You must use AWS Developer credentials to call this API.
///
///
/// Container for the necessary parameters to execute the UpdateIdentityPool service method.
///
/// The response from the UpdateIdentityPool 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 the total number of user pools has exceeded a preset limit.
///
///
/// 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 UpdateIdentityPool Operation
public virtual UpdateIdentityPoolResponse UpdateIdentityPool(UpdateIdentityPoolRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = UpdateIdentityPoolRequestMarshaller.Instance;
options.ResponseUnmarshaller = UpdateIdentityPoolResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Updates an identity pool.
///
///
///
/// You must use AWS Developer credentials to call this API.
///
///
/// Container for the necessary parameters to execute the UpdateIdentityPool service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateIdentityPool 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 the total number of user pools has exceeded a preset limit.
///
///
/// 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 UpdateIdentityPool Operation
public virtual Task UpdateIdentityPoolAsync(UpdateIdentityPoolRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = UpdateIdentityPoolRequestMarshaller.Instance;
options.ResponseUnmarshaller = UpdateIdentityPoolResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
}
}