AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Creates an app client in a user pool. This operation sets basic and advanced configuration options.

Unlike app clients created in the console, Amazon Cognito doesn't automatically assign a branding style to app clients that you configure with this API operation. Managed login and classic hosted UI pages aren't available for your client until after you apply a branding style.

If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginCreateUserPoolClient and EndCreateUserPoolClient.

Namespace: Amazon.CognitoIdentityProvider
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z

Syntax

C#
public virtual Task<CreateUserPoolClientResponse> CreateUserPoolClientAsync(
         CreateUserPoolClientRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.CognitoIdentityProvider.Model.CreateUserPoolClientRequest

Container for the necessary parameters to execute the CreateUserPoolClient service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the CreateUserPoolClient service method, as returned by CognitoIdentityProvider.

Exceptions

ExceptionCondition
FeatureUnavailableInTierException This exception is thrown when a feature you attempted to configure isn't available in your current feature plan.
InternalErrorException This exception is thrown when Amazon Cognito encounters an internal error.
InvalidOAuthFlowException This exception is thrown when the specified OAuth flow is not valid.
InvalidParameterException This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
LimitExceededException This exception is thrown when a user exceeds the limit for a requested Amazon Web Services resource.
NotAuthorizedException This exception is thrown when a user isn't authorized.
ResourceNotFoundException This exception is thrown when the Amazon Cognito service can't find the requested resource.
ScopeDoesNotExistException This exception is thrown when the specified scope doesn't exist.
TooManyRequestsException This exception is thrown when the user has made too many requests for a given operation.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer

See Also