| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.SWF.DescribeDomain
Description
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
Resourceelement with the domain name to limit the action to only specified domains. - Use an
Actionelement to allow or deny permission to call this action. - You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't 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 is set
to OPERATION_NOT_PERMITTED. For details and example IAM policies, see
Using IAM to Manage Access to Amazon SWF Workflows
in the Amazon SWF Developer Guide.
Synopsis
- data DescribeDomain = DescribeDomain' {}
- newDescribeDomain :: Text -> DescribeDomain
- describeDomain_name :: Lens' DescribeDomain Text
- data DescribeDomainResponse = DescribeDomainResponse' {}
- newDescribeDomainResponse :: Int -> DomainInfo -> DomainConfiguration -> DescribeDomainResponse
- describeDomainResponse_httpStatus :: Lens' DescribeDomainResponse Int
- describeDomainResponse_domainInfo :: Lens' DescribeDomainResponse DomainInfo
- describeDomainResponse_configuration :: Lens' DescribeDomainResponse DomainConfiguration
Creating a Request
data DescribeDomain Source #
See: newDescribeDomain smart constructor.
Constructors
| DescribeDomain' | |
Instances
Arguments
| :: Text | |
| -> DescribeDomain |
Create a value of DescribeDomain with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:DescribeDomain', describeDomain_name - The name of the domain to describe.
Request Lenses
describeDomain_name :: Lens' DescribeDomain Text Source #
The name of the domain to describe.
Destructuring the Response
data DescribeDomainResponse Source #
Contains details of a domain.
See: newDescribeDomainResponse smart constructor.
Constructors
| DescribeDomainResponse' | |
Fields
| |
Instances
newDescribeDomainResponse Source #
Arguments
| :: Int | |
| -> DomainInfo | |
| -> DomainConfiguration | |
| -> DescribeDomainResponse |
Create a value of DescribeDomainResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeDomainResponse', describeDomainResponse_httpStatus - The response's http status code.
$sel:domainInfo:DescribeDomainResponse', describeDomainResponse_domainInfo - The basic information about a domain, such as its name, status, and
description.
$sel:configuration:DescribeDomainResponse', describeDomainResponse_configuration - The domain configuration. Currently, this includes only the domain's
retention period.
Response Lenses
describeDomainResponse_httpStatus :: Lens' DescribeDomainResponse Int Source #
The response's http status code.
describeDomainResponse_domainInfo :: Lens' DescribeDomainResponse DomainInfo Source #
The basic information about a domain, such as its name, status, and description.
describeDomainResponse_configuration :: Lens' DescribeDomainResponse DomainConfiguration Source #
The domain configuration. Currently, this includes only the domain's retention period.