Describe User Pool Domain

cognitoidentityprovider_describe_user_pool_domain

R Documentation

Gets information about a domain¶

Description¶

Gets information about a domain.

Usage¶

cognitoidentityprovider_describe_user_pool_domain(Domain)

Arguments¶

Domain: [required] The domain string. 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"
    )
  )
)

Request syntax¶

svc$describe_user_pool_domain(
  Domain = "string"
)