libZSservicesZSamazonka-swfZSamazonka-swf
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

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 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 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

Creating a Request

data DescribeDomain Source #

See: newDescribeDomain smart constructor.

Constructors

DescribeDomain' 

Fields

  • name :: Text

    The name of the domain to describe.

Instances

Instances details
Eq DescribeDomain Source # 
Instance details

Defined in Amazonka.SWF.DescribeDomain

Read DescribeDomain Source # 
Instance details

Defined in Amazonka.SWF.DescribeDomain

Show DescribeDomain Source # 
Instance details

Defined in Amazonka.SWF.DescribeDomain

Generic DescribeDomain Source # 
Instance details

Defined in Amazonka.SWF.DescribeDomain

Associated Types

type Rep DescribeDomain :: Type -> Type #

NFData DescribeDomain Source # 
Instance details

Defined in Amazonka.SWF.DescribeDomain

Methods

rnf :: DescribeDomain -> () #

Hashable DescribeDomain Source # 
Instance details

Defined in Amazonka.SWF.DescribeDomain

ToJSON DescribeDomain Source # 
Instance details

Defined in Amazonka.SWF.DescribeDomain

AWSRequest DescribeDomain Source # 
Instance details

Defined in Amazonka.SWF.DescribeDomain

Associated Types

type AWSResponse DescribeDomain #

ToHeaders DescribeDomain Source # 
Instance details

Defined in Amazonka.SWF.DescribeDomain

ToPath DescribeDomain Source # 
Instance details

Defined in Amazonka.SWF.DescribeDomain

ToQuery DescribeDomain Source # 
Instance details

Defined in Amazonka.SWF.DescribeDomain

type Rep DescribeDomain Source # 
Instance details

Defined in Amazonka.SWF.DescribeDomain

type Rep DescribeDomain = D1 ('MetaData "DescribeDomain" "Amazonka.SWF.DescribeDomain" "libZSservicesZSamazonka-swfZSamazonka-swf" 'False) (C1 ('MetaCons "DescribeDomain'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeDomain Source # 
Instance details

Defined in Amazonka.SWF.DescribeDomain

newDescribeDomain Source #

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

Instances details
Eq DescribeDomainResponse Source # 
Instance details

Defined in Amazonka.SWF.DescribeDomain

Read DescribeDomainResponse Source # 
Instance details

Defined in Amazonka.SWF.DescribeDomain

Show DescribeDomainResponse Source # 
Instance details

Defined in Amazonka.SWF.DescribeDomain

Generic DescribeDomainResponse Source # 
Instance details

Defined in Amazonka.SWF.DescribeDomain

Associated Types

type Rep DescribeDomainResponse :: Type -> Type #

NFData DescribeDomainResponse Source # 
Instance details

Defined in Amazonka.SWF.DescribeDomain

Methods

rnf :: DescribeDomainResponse -> () #

type Rep DescribeDomainResponse Source # 
Instance details

Defined in Amazonka.SWF.DescribeDomain

type Rep DescribeDomainResponse = D1 ('MetaData "DescribeDomainResponse" "Amazonka.SWF.DescribeDomain" "libZSservicesZSamazonka-swfZSamazonka-swf" 'False) (C1 ('MetaCons "DescribeDomainResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "domainInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DomainInfo) :*: S1 ('MetaSel ('Just "configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DomainConfiguration))))

newDescribeDomainResponse Source #

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_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.