Network.AWS.SWF.DescribeDomain

Returns information about the specified domain, including description and status.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

• Use a Resource element with the domain name to limit the action to only specified domains.
• Use an Action element to allow or deny permission to call this action.
• You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

See: AWS API Reference for DescribeDomain.

Creating a Request

describeDomain

Arguments

:: Text

ddName

-> DescribeDomain

Creates a value of DescribeDomain with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ddName

data DescribeDomain

See: describeDomain smart constructor.

Instances

Eq DescribeDomain

Data DescribeDomain

Read DescribeDomain

Show DescribeDomain

Generic DescribeDomain

ToJSON DescribeDomain

AWSRequest DescribeDomain

ToPath DescribeDomain

ToHeaders DescribeDomain

ToQuery DescribeDomain

Typeable * DescribeDomain

type Rep DescribeDomain

type Rs DescribeDomain = DescribeDomainResponse

Request Lenses

ddName :: Lens' DescribeDomain Text

The name of the domain to describe.

Destructuring the Response

describeDomainResponse

Arguments

:: Int

ddrsStatus

-> DomainInfo

ddrsDomainInfo

-> DomainConfiguration

ddrsConfiguration

-> DescribeDomainResponse

Creates a value of DescribeDomainResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ddrsStatus
• ddrsDomainInfo
• ddrsConfiguration

data DescribeDomainResponse

Contains details of a domain.

See: describeDomainResponse smart constructor.

Instances

Eq DescribeDomainResponse

Data DescribeDomainResponse

Read DescribeDomainResponse

Show DescribeDomainResponse

Generic DescribeDomainResponse

Typeable * DescribeDomainResponse

type Rep DescribeDomainResponse

Response Lenses

ddrsStatus :: Lens' DescribeDomainResponse Int

The response status code.

ddrsDomainInfo :: Lens' DescribeDomainResponse DomainInfo

Undocumented member.

ddrsConfiguration :: Lens' DescribeDomainResponse DomainConfiguration

Undocumented member.