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.

Classes

NameDescription
Class AccountTakeoverEventActionType

Constants used for properties of type AccountTakeoverEventActionType.

Class AdvancedSecurityModeType

Constants used for properties of type AdvancedSecurityModeType.

Class AliasAttributeType

Constants used for properties of type AliasAttributeType.

Class AmazonCognitoIdentityProviderClient

Implementation for accessing CognitoIdentityProvider

With the Amazon Cognito user pools API, you can configure user pools and authenticate users. To authenticate users from third-party identity providers (IdPs) in this API, you can link IdP users to native user profiles. Learn more about the authentication and authorization of federated users at Adding user pool sign-in through a third party and in the User pool federation endpoints and hosted UI reference.

This API reference provides detailed information about API operations and object types in Amazon Cognito.

Along with resource management operations, the Amazon Cognito user pools API includes classes of operations and authorization models for client-side and server-side authentication of users. You can interact with operations in the Amazon Cognito user pools API as any of the following subjects.

  1. An administrator who wants to configure user pools, app clients, users, groups, or other user pool functions.

  2. A server-side app, like a web application, that wants to use its Amazon Web Services privileges to manage, authenticate, or authorize a user.

  3. A client-side app, like a mobile app, that wants to make unauthenticated requests to manage, authenticate, or authorize a user.

For more information, see Using the Amazon Cognito user pools API and user pool endpoints in the Amazon Cognito Developer Guide.

With your Amazon Web Services SDK, you can build the logic to support operational flows in every use case for this API. You can also make direct REST API requests to Amazon Cognito user pools service endpoints. The following links can get you started with the CognitoIdentityProvider client in other supported Amazon Web Services SDKs.

To get started with an Amazon Web Services SDK, see Tools to Build on Amazon Web Services. For example actions and scenarios, see Code examples for Amazon Cognito Identity Provider using Amazon Web Services SDKs.

Class AmazonCognitoIdentityProviderConfig

Configuration for accessing Amazon CognitoIdentityProvider service

Class AmazonCognitoIdentityProviderDefaultConfiguration

Configuration for accessing Amazon CognitoIdentityProvider service

Class AmazonCognitoIdentityProviderException

Common exception for the CognitoIdentityProvider service.

Class AmazonCognitoIdentityProviderRequest

Base class for CognitoIdentityProvider operation requests.

Class AttributeDataType

Constants used for properties of type AttributeDataType.

Class AuthFlowType

Constants used for properties of type AuthFlowType.

Class ChallengeName

Constants used for properties of type ChallengeName.

Class ChallengeNameType

Constants used for properties of type ChallengeNameType.

Class ChallengeResponse

Constants used for properties of type ChallengeResponse.

Class CompromisedCredentialsEventActionType

Constants used for properties of type CompromisedCredentialsEventActionType.

Class CustomEmailSenderLambdaVersionType

Constants used for properties of type CustomEmailSenderLambdaVersionType.

Class CustomSMSSenderLambdaVersionType

Constants used for properties of type CustomSMSSenderLambdaVersionType.

Class DefaultEmailOptionType

Constants used for properties of type DefaultEmailOptionType.

Class DeletionProtectionType

Constants used for properties of type DeletionProtectionType.

Class DeliveryMediumType

Constants used for properties of type DeliveryMediumType.

Class DeviceRememberedStatusType

Constants used for properties of type DeviceRememberedStatusType.

Class DomainStatusType

Constants used for properties of type DomainStatusType.

Class EmailSendingAccountType

Constants used for properties of type EmailSendingAccountType.

Class EventFilterType

Constants used for properties of type EventFilterType.

Class EventResponseType

Constants used for properties of type EventResponseType.

Class EventSourceName

Constants used for properties of type EventSourceName.

Class EventType

Constants used for properties of type EventType.

Class ExplicitAuthFlowsType

Constants used for properties of type ExplicitAuthFlowsType.

Class FeedbackValueType

Constants used for properties of type FeedbackValueType.

Class IdentityProviderTypeType

Constants used for properties of type IdentityProviderTypeType.

Class LogLevel

Constants used for properties of type LogLevel.

Class MessageActionType

Constants used for properties of type MessageActionType.

Class OAuthFlowType

Constants used for properties of type OAuthFlowType.

Class PreTokenGenerationLambdaVersionType

Constants used for properties of type PreTokenGenerationLambdaVersionType.

Class PreventUserExistenceErrorTypes

Constants used for properties of type PreventUserExistenceErrorTypes.

Class RecoveryOptionNameType

Constants used for properties of type RecoveryOptionNameType.

Class RiskDecisionType

Constants used for properties of type RiskDecisionType.

Class RiskLevelType

Constants used for properties of type RiskLevelType.

Class StatusType

Constants used for properties of type StatusType.

Class TimeUnitsType

Constants used for properties of type TimeUnitsType.

Class UserImportJobStatusType

Constants used for properties of type UserImportJobStatusType.

Class UsernameAttributeType

Constants used for properties of type UsernameAttributeType.

Class UserPoolMfaType

Constants used for properties of type UserPoolMfaType.

Class UserStatusType

Constants used for properties of type UserStatusType.

Class VerifiedAttributeType

Constants used for properties of type VerifiedAttributeType.

Class VerifySoftwareTokenResponseType

Constants used for properties of type VerifySoftwareTokenResponseType.

Interfaces

NameDescription
Interface IAmazonCognitoIdentityProvider

Interface for accessing CognitoIdentityProvider

With the Amazon Cognito user pools API, you can configure user pools and authenticate users. To authenticate users from third-party identity providers (IdPs) in this API, you can link IdP users to native user profiles. Learn more about the authentication and authorization of federated users at Adding user pool sign-in through a third party and in the User pool federation endpoints and hosted UI reference.

This API reference provides detailed information about API operations and object types in Amazon Cognito.

Along with resource management operations, the Amazon Cognito user pools API includes classes of operations and authorization models for client-side and server-side authentication of users. You can interact with operations in the Amazon Cognito user pools API as any of the following subjects.

  1. An administrator who wants to configure user pools, app clients, users, groups, or other user pool functions.

  2. A server-side app, like a web application, that wants to use its Amazon Web Services privileges to manage, authenticate, or authorize a user.

  3. A client-side app, like a mobile app, that wants to make unauthenticated requests to manage, authenticate, or authorize a user.

For more information, see Using the Amazon Cognito user pools API and user pool endpoints in the Amazon Cognito Developer Guide.

With your Amazon Web Services SDK, you can build the logic to support operational flows in every use case for this API. You can also make direct REST API requests to Amazon Cognito user pools service endpoints. The following links can get you started with the CognitoIdentityProvider client in other supported Amazon Web Services SDKs.

To get started with an Amazon Web Services SDK, see Tools to Build on Amazon Web Services. For example actions and scenarios, see Code examples for Amazon Cognito Identity Provider using Amazon Web Services SDKs.