Describe User Pool Domain

cognitoidentityprovider_describe_user_pool_domain

R Documentation

Given a user pool domain name, returns information about the domain configuration¶

Description¶

Given a user pool domain name, returns information about the domain configuration.

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

Usage¶

cognitoidentityprovider_describe_user_pool_domain(Domain)

Arguments¶

Domain: [required] The domain that you want to describe. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.

Value¶

A list with the following syntax:

list(
  DomainDescription = list(
    UserPoolId = "string",
    AWSAccountId = "string",
    Domain = "string",
    S3Bucket = "string",
    CloudFrontDistribution = "string",
    Version = "string",
    Status = "CREATING"|"DELETING"|"UPDATING"|"ACTIVE"|"FAILED",
    CustomDomainConfig = list(
      CertificateArn = "string"
    ),
    ManagedLoginVersion = 123
  )
)

Request syntax¶

svc$describe_user_pool_domain(
  Domain = "string"
)