libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation
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.CloudFormation.DescribeTypeRegistration

Description

Returns information about an extension's registration, including its current status and type and version identifiers.

When you initiate a registration request using RegisterType , you can then use DescribeTypeRegistration to monitor the progress of that registration request.

Once the registration request has completed, use DescribeType to return detailed information about an extension.

Synopsis

Creating a Request

data DescribeTypeRegistration Source #

See: newDescribeTypeRegistration smart constructor.

Constructors

DescribeTypeRegistration' 

Fields

  • registrationToken :: Text

    The identifier for this registration request.

    This registration token is generated by CloudFormation when you initiate a registration request using RegisterType .

Instances

Instances details
Eq DescribeTypeRegistration Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeTypeRegistration

Methods

(==) :: DescribeTypeRegistration -> DescribeTypeRegistration -> Bool #

(/=) :: DescribeTypeRegistration -> DescribeTypeRegistration -> Bool #

Read DescribeTypeRegistration Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeTypeRegistration

Methods

readsPrec :: Int -> ReadS DescribeTypeRegistration #

readList :: ReadS [DescribeTypeRegistration] #

readPrec :: ReadPrec DescribeTypeRegistration #

readListPrec :: ReadPrec [DescribeTypeRegistration] #

Show DescribeTypeRegistration Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeTypeRegistration

Methods

showsPrec :: Int -> DescribeTypeRegistration -> ShowS #

show :: DescribeTypeRegistration -> String #

showList :: [DescribeTypeRegistration] -> ShowS #

Generic DescribeTypeRegistration Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeTypeRegistration

Associated Types

type Rep DescribeTypeRegistration :: Type -> Type #

Methods

from :: DescribeTypeRegistration -> Rep DescribeTypeRegistration x #

to :: Rep DescribeTypeRegistration x -> DescribeTypeRegistration #

NFData DescribeTypeRegistration Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeTypeRegistration

Methods

rnf :: DescribeTypeRegistration -> () #

Hashable DescribeTypeRegistration Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeTypeRegistration

Methods

hashWithSalt :: Int -> DescribeTypeRegistration -> Int #

hash :: DescribeTypeRegistration -> Int #

AWSRequest DescribeTypeRegistration Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeTypeRegistration

Associated Types

type AWSResponse DescribeTypeRegistration #

Methods

request :: DescribeTypeRegistration -> Request DescribeTypeRegistration #

response :: MonadResource m => Logger -> Service -> Proxy DescribeTypeRegistration -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeTypeRegistration))) #

ToHeaders DescribeTypeRegistration Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeTypeRegistration

Methods

toHeaders :: DescribeTypeRegistration -> [Header] #

ToPath DescribeTypeRegistration Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeTypeRegistration

Methods

toPath :: DescribeTypeRegistration -> ByteString #

ToQuery DescribeTypeRegistration Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeTypeRegistration

Methods

toQuery :: DescribeTypeRegistration -> QueryString #

type Rep DescribeTypeRegistration Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeTypeRegistration

type Rep DescribeTypeRegistration = D1 ('MetaData "DescribeTypeRegistration" "Amazonka.CloudFormation.DescribeTypeRegistration" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" 'False) (C1 ('MetaCons "DescribeTypeRegistration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "registrationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeTypeRegistration Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeTypeRegistration

type AWSResponse DescribeTypeRegistration = DescribeTypeRegistrationResponse

newDescribeTypeRegistration Source #

Arguments

:: Text

$sel:registrationToken:DescribeTypeRegistration'

-> DescribeTypeRegistration 

Create a value of DescribeTypeRegistration 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:registrationToken:DescribeTypeRegistration', describeTypeRegistration_registrationToken - The identifier for this registration request.

This registration token is generated by CloudFormation when you initiate a registration request using RegisterType .

Request Lenses

describeTypeRegistration_registrationToken :: Lens' DescribeTypeRegistration Text Source #

The identifier for this registration request.

This registration token is generated by CloudFormation when you initiate a registration request using RegisterType .

Destructuring the Response

data DescribeTypeRegistrationResponse Source #

See: newDescribeTypeRegistrationResponse smart constructor.

Constructors

DescribeTypeRegistrationResponse' 

Fields

  • typeVersionArn :: Maybe Text

    The Amazon Resource Name (ARN) of this specific version of the extension being registered.

    For registration requests with a ProgressStatus of other than COMPLETE, this will be null.

  • progressStatus :: Maybe RegistrationStatus

    The current status of the extension registration request.

  • typeArn :: Maybe Text

    The Amazon Resource Name (ARN) of the extension being registered.

    For registration requests with a ProgressStatus of other than COMPLETE, this will be null.

  • description :: Maybe Text

    The description of the extension registration request.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq DescribeTypeRegistrationResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeTypeRegistration

Methods

(==) :: DescribeTypeRegistrationResponse -> DescribeTypeRegistrationResponse -> Bool #

(/=) :: DescribeTypeRegistrationResponse -> DescribeTypeRegistrationResponse -> Bool #

Read DescribeTypeRegistrationResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeTypeRegistration

Methods

readsPrec :: Int -> ReadS DescribeTypeRegistrationResponse #

readList :: ReadS [DescribeTypeRegistrationResponse] #

readPrec :: ReadPrec DescribeTypeRegistrationResponse #

readListPrec :: ReadPrec [DescribeTypeRegistrationResponse] #

Show DescribeTypeRegistrationResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeTypeRegistration

Methods

showsPrec :: Int -> DescribeTypeRegistrationResponse -> ShowS #

show :: DescribeTypeRegistrationResponse -> String #

showList :: [DescribeTypeRegistrationResponse] -> ShowS #

Generic DescribeTypeRegistrationResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeTypeRegistration

Associated Types

type Rep DescribeTypeRegistrationResponse :: Type -> Type #

Methods

from :: DescribeTypeRegistrationResponse -> Rep DescribeTypeRegistrationResponse x #

to :: Rep DescribeTypeRegistrationResponse x -> DescribeTypeRegistrationResponse #

NFData DescribeTypeRegistrationResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeTypeRegistration

Methods

rnf :: DescribeTypeRegistrationResponse -> () #

type Rep DescribeTypeRegistrationResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeTypeRegistration

type Rep DescribeTypeRegistrationResponse = D1 ('MetaData "DescribeTypeRegistrationResponse" "Amazonka.CloudFormation.DescribeTypeRegistration" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" 'False) (C1 ('MetaCons "DescribeTypeRegistrationResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "typeVersionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "progressStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RegistrationStatus))) :*: (S1 ('MetaSel ('Just "typeArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newDescribeTypeRegistrationResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeTypeRegistrationResponse'

-> DescribeTypeRegistrationResponse 

Create a value of DescribeTypeRegistrationResponse 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:typeVersionArn:DescribeTypeRegistrationResponse', describeTypeRegistrationResponse_typeVersionArn - The Amazon Resource Name (ARN) of this specific version of the extension being registered.

For registration requests with a ProgressStatus of other than COMPLETE, this will be null.

$sel:progressStatus:DescribeTypeRegistrationResponse', describeTypeRegistrationResponse_progressStatus - The current status of the extension registration request.

$sel:typeArn:DescribeTypeRegistrationResponse', describeTypeRegistrationResponse_typeArn - The Amazon Resource Name (ARN) of the extension being registered.

For registration requests with a ProgressStatus of other than COMPLETE, this will be null.

$sel:description:DescribeTypeRegistrationResponse', describeTypeRegistrationResponse_description - The description of the extension registration request.

$sel:httpStatus:DescribeTypeRegistrationResponse', describeTypeRegistrationResponse_httpStatus - The response's http status code.

Response Lenses

describeTypeRegistrationResponse_typeVersionArn :: Lens' DescribeTypeRegistrationResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of this specific version of the extension being registered.

For registration requests with a ProgressStatus of other than COMPLETE, this will be null.

describeTypeRegistrationResponse_progressStatus :: Lens' DescribeTypeRegistrationResponse (Maybe RegistrationStatus) Source #

The current status of the extension registration request.

describeTypeRegistrationResponse_typeArn :: Lens' DescribeTypeRegistrationResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the extension being registered.

For registration requests with a ProgressStatus of other than COMPLETE, this will be null.

describeTypeRegistrationResponse_description :: Lens' DescribeTypeRegistrationResponse (Maybe Text) Source #

The description of the extension registration request.

describeTypeRegistrationResponse_httpStatus :: Lens' DescribeTypeRegistrationResponse Int Source #

The response's http status code.