amazonka-cloudformation-2.0: Amazon CloudFormation SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CloudFormation.ListTypeRegistrations

Description

Returns a list of registration tokens for the specified extension(s).

Synopsis

Creating a Request

data ListTypeRegistrations Source #

See: newListTypeRegistrations smart constructor.

Constructors

ListTypeRegistrations' 

Fields

  • maxResults :: Maybe Natural

    The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

  • nextToken :: Maybe Text

    If the previous paginated request didn't return all the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

  • registrationStatusFilter :: Maybe RegistrationStatus

    The current status of the extension registration request.

    The default is IN_PROGRESS.

  • type' :: Maybe RegistryType

    The kind of extension.

    Conditional: You must specify either TypeName and Type, or Arn.

  • typeArn :: Maybe Text

    The Amazon Resource Name (ARN) of the extension.

    Conditional: You must specify either TypeName and Type, or Arn.

  • typeName :: Maybe Text

    The name of the extension.

    Conditional: You must specify either TypeName and Type, or Arn.

Instances

Instances details
ToHeaders ListTypeRegistrations Source # 
Instance details

Defined in Amazonka.CloudFormation.ListTypeRegistrations

ToPath ListTypeRegistrations Source # 
Instance details

Defined in Amazonka.CloudFormation.ListTypeRegistrations

ToQuery ListTypeRegistrations Source # 
Instance details

Defined in Amazonka.CloudFormation.ListTypeRegistrations

AWSRequest ListTypeRegistrations Source # 
Instance details

Defined in Amazonka.CloudFormation.ListTypeRegistrations

Associated Types

type AWSResponse ListTypeRegistrations #

Generic ListTypeRegistrations Source # 
Instance details

Defined in Amazonka.CloudFormation.ListTypeRegistrations

Associated Types

type Rep ListTypeRegistrations :: Type -> Type #

Read ListTypeRegistrations Source # 
Instance details

Defined in Amazonka.CloudFormation.ListTypeRegistrations

Show ListTypeRegistrations Source # 
Instance details

Defined in Amazonka.CloudFormation.ListTypeRegistrations

NFData ListTypeRegistrations Source # 
Instance details

Defined in Amazonka.CloudFormation.ListTypeRegistrations

Methods

rnf :: ListTypeRegistrations -> () #

Eq ListTypeRegistrations Source # 
Instance details

Defined in Amazonka.CloudFormation.ListTypeRegistrations

Hashable ListTypeRegistrations Source # 
Instance details

Defined in Amazonka.CloudFormation.ListTypeRegistrations

type AWSResponse ListTypeRegistrations Source # 
Instance details

Defined in Amazonka.CloudFormation.ListTypeRegistrations

type Rep ListTypeRegistrations Source # 
Instance details

Defined in Amazonka.CloudFormation.ListTypeRegistrations

type Rep ListTypeRegistrations = D1 ('MetaData "ListTypeRegistrations" "Amazonka.CloudFormation.ListTypeRegistrations" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "ListTypeRegistrations'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "registrationStatusFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RegistrationStatus)))) :*: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RegistryType)) :*: (S1 ('MetaSel ('Just "typeArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "typeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newListTypeRegistrations :: ListTypeRegistrations Source #

Create a value of ListTypeRegistrations 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:maxResults:ListTypeRegistrations', listTypeRegistrations_maxResults - The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

ListTypeRegistrations, listTypeRegistrations_nextToken - If the previous paginated request didn't return all the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

$sel:registrationStatusFilter:ListTypeRegistrations', listTypeRegistrations_registrationStatusFilter - The current status of the extension registration request.

The default is IN_PROGRESS.

ListTypeRegistrations, listTypeRegistrations_type - The kind of extension.

Conditional: You must specify either TypeName and Type, or Arn.

ListTypeRegistrations, listTypeRegistrations_typeArn - The Amazon Resource Name (ARN) of the extension.

Conditional: You must specify either TypeName and Type, or Arn.

ListTypeRegistrations, listTypeRegistrations_typeName - The name of the extension.

Conditional: You must specify either TypeName and Type, or Arn.

Request Lenses

listTypeRegistrations_maxResults :: Lens' ListTypeRegistrations (Maybe Natural) Source #

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

listTypeRegistrations_nextToken :: Lens' ListTypeRegistrations (Maybe Text) Source #

If the previous paginated request didn't return all the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

listTypeRegistrations_registrationStatusFilter :: Lens' ListTypeRegistrations (Maybe RegistrationStatus) Source #

The current status of the extension registration request.

The default is IN_PROGRESS.

listTypeRegistrations_type :: Lens' ListTypeRegistrations (Maybe RegistryType) Source #

The kind of extension.

Conditional: You must specify either TypeName and Type, or Arn.

listTypeRegistrations_typeArn :: Lens' ListTypeRegistrations (Maybe Text) Source #

The Amazon Resource Name (ARN) of the extension.

Conditional: You must specify either TypeName and Type, or Arn.

listTypeRegistrations_typeName :: Lens' ListTypeRegistrations (Maybe Text) Source #

The name of the extension.

Conditional: You must specify either TypeName and Type, or Arn.

Destructuring the Response

data ListTypeRegistrationsResponse Source #

See: newListTypeRegistrationsResponse smart constructor.

Constructors

ListTypeRegistrationsResponse' 

Fields

  • nextToken :: Maybe Text

    If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

  • registrationTokenList :: Maybe [Text]

    A list of extension registration tokens.

    Use DescribeTypeRegistration to return detailed information about a type registration request.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListTypeRegistrationsResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ListTypeRegistrations

Associated Types

type Rep ListTypeRegistrationsResponse :: Type -> Type #

Read ListTypeRegistrationsResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ListTypeRegistrations

Show ListTypeRegistrationsResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ListTypeRegistrations

NFData ListTypeRegistrationsResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ListTypeRegistrations

Eq ListTypeRegistrationsResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ListTypeRegistrations

type Rep ListTypeRegistrationsResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ListTypeRegistrations

type Rep ListTypeRegistrationsResponse = D1 ('MetaData "ListTypeRegistrationsResponse" "Amazonka.CloudFormation.ListTypeRegistrations" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "ListTypeRegistrationsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "registrationTokenList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListTypeRegistrationsResponse Source #

Create a value of ListTypeRegistrationsResponse 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:

ListTypeRegistrations, listTypeRegistrationsResponse_nextToken - If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

$sel:registrationTokenList:ListTypeRegistrationsResponse', listTypeRegistrationsResponse_registrationTokenList - A list of extension registration tokens.

Use DescribeTypeRegistration to return detailed information about a type registration request.

$sel:httpStatus:ListTypeRegistrationsResponse', listTypeRegistrationsResponse_httpStatus - The response's http status code.

Response Lenses

listTypeRegistrationsResponse_nextToken :: Lens' ListTypeRegistrationsResponse (Maybe Text) Source #

If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

listTypeRegistrationsResponse_registrationTokenList :: Lens' ListTypeRegistrationsResponse (Maybe [Text]) Source #

A list of extension registration tokens.

Use DescribeTypeRegistration to return detailed information about a type registration request.