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

Description

Returns summary information about extension that have been registered with CloudFormation.

This operation returns paginated results.

Synopsis

Creating a Request

data ListTypes Source #

See: newListTypes smart constructor.

Constructors

ListTypes' 

Fields

  • deprecatedStatus :: Maybe DeprecatedStatus

    The deprecation status of the extension that you want to get summary information about.

    Valid values include:

    • LIVE: The extension is registered for use in CloudFormation operations.
    • DEPRECATED: The extension has been deregistered and can no longer be used in CloudFormation operations.
  • filters :: Maybe TypeFilters

    Filter criteria to use in determining which extensions to return.

    Filters must be compatible with Visibility to return valid results. For example, specifying AWS_TYPES for Category and PRIVATE for Visibility returns an empty list of types, but specifying PUBLIC for Visibility returns the desired list.

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

  • provisioningType :: Maybe ProvisioningType

    For resource types, the provisioning behavior of the resource type. CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

    Valid values include:

    • FULLY_MUTABLE: The resource type includes an update handler to process updates to the type during stack update operations.
    • IMMUTABLE: The resource type doesn't include an update handler, so the type can't be updated and must instead be replaced during stack update operations.
    • NON_PROVISIONABLE: The resource type doesn't include create, read, and delete handlers, and therefore can't actually be provisioned.

    The default is FULLY_MUTABLE.

  • type' :: Maybe RegistryType

    The type of extension.

  • visibility :: Maybe Visibility

    The scope at which the extensions are visible and usable in CloudFormation operations.

    Valid values include:

    • PRIVATE: Extensions that are visible and usable within this account and region. This includes:

      • Private extensions you have registered in this account and region.
      • Public extensions that you have activated in this account and region.
    • PUBLIC: Extensions that are publicly visible and available to be activated within any Amazon Web Services account. This includes extensions from Amazon Web Services, in addition to third-party publishers.

    The default is PRIVATE.

Instances

Instances details
ToHeaders ListTypes Source # 
Instance details

Defined in Amazonka.CloudFormation.ListTypes

Methods

toHeaders :: ListTypes -> [Header] #

ToPath ListTypes Source # 
Instance details

Defined in Amazonka.CloudFormation.ListTypes

ToQuery ListTypes Source # 
Instance details

Defined in Amazonka.CloudFormation.ListTypes

AWSPager ListTypes Source # 
Instance details

Defined in Amazonka.CloudFormation.ListTypes

AWSRequest ListTypes Source # 
Instance details

Defined in Amazonka.CloudFormation.ListTypes

Associated Types

type AWSResponse ListTypes #

Generic ListTypes Source # 
Instance details

Defined in Amazonka.CloudFormation.ListTypes

Associated Types

type Rep ListTypes :: Type -> Type #

Read ListTypes Source # 
Instance details

Defined in Amazonka.CloudFormation.ListTypes

Show ListTypes Source # 
Instance details

Defined in Amazonka.CloudFormation.ListTypes

NFData ListTypes Source # 
Instance details

Defined in Amazonka.CloudFormation.ListTypes

Methods

rnf :: ListTypes -> () #

Eq ListTypes Source # 
Instance details

Defined in Amazonka.CloudFormation.ListTypes

Hashable ListTypes Source # 
Instance details

Defined in Amazonka.CloudFormation.ListTypes

type AWSResponse ListTypes Source # 
Instance details

Defined in Amazonka.CloudFormation.ListTypes

type Rep ListTypes Source # 
Instance details

Defined in Amazonka.CloudFormation.ListTypes

newListTypes :: ListTypes Source #

Create a value of ListTypes 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:deprecatedStatus:ListTypes', listTypes_deprecatedStatus - The deprecation status of the extension that you want to get summary information about.

Valid values include:

  • LIVE: The extension is registered for use in CloudFormation operations.
  • DEPRECATED: The extension has been deregistered and can no longer be used in CloudFormation operations.

$sel:filters:ListTypes', listTypes_filters - Filter criteria to use in determining which extensions to return.

Filters must be compatible with Visibility to return valid results. For example, specifying AWS_TYPES for Category and PRIVATE for Visibility returns an empty list of types, but specifying PUBLIC for Visibility returns the desired list.

$sel:maxResults:ListTypes', listTypes_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.

ListTypes, listTypes_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:provisioningType:ListTypes', listTypes_provisioningType - For resource types, the provisioning behavior of the resource type. CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

Valid values include:

  • FULLY_MUTABLE: The resource type includes an update handler to process updates to the type during stack update operations.
  • IMMUTABLE: The resource type doesn't include an update handler, so the type can't be updated and must instead be replaced during stack update operations.
  • NON_PROVISIONABLE: The resource type doesn't include create, read, and delete handlers, and therefore can't actually be provisioned.

The default is FULLY_MUTABLE.

ListTypes, listTypes_type - The type of extension.

$sel:visibility:ListTypes', listTypes_visibility - The scope at which the extensions are visible and usable in CloudFormation operations.

Valid values include:

  • PRIVATE: Extensions that are visible and usable within this account and region. This includes:

    • Private extensions you have registered in this account and region.
    • Public extensions that you have activated in this account and region.
  • PUBLIC: Extensions that are publicly visible and available to be activated within any Amazon Web Services account. This includes extensions from Amazon Web Services, in addition to third-party publishers.

The default is PRIVATE.

Request Lenses

listTypes_deprecatedStatus :: Lens' ListTypes (Maybe DeprecatedStatus) Source #

The deprecation status of the extension that you want to get summary information about.

Valid values include:

  • LIVE: The extension is registered for use in CloudFormation operations.
  • DEPRECATED: The extension has been deregistered and can no longer be used in CloudFormation operations.

listTypes_filters :: Lens' ListTypes (Maybe TypeFilters) Source #

Filter criteria to use in determining which extensions to return.

Filters must be compatible with Visibility to return valid results. For example, specifying AWS_TYPES for Category and PRIVATE for Visibility returns an empty list of types, but specifying PUBLIC for Visibility returns the desired list.

listTypes_maxResults :: Lens' ListTypes (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.

listTypes_nextToken :: Lens' ListTypes (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.

listTypes_provisioningType :: Lens' ListTypes (Maybe ProvisioningType) Source #

For resource types, the provisioning behavior of the resource type. CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

Valid values include:

  • FULLY_MUTABLE: The resource type includes an update handler to process updates to the type during stack update operations.
  • IMMUTABLE: The resource type doesn't include an update handler, so the type can't be updated and must instead be replaced during stack update operations.
  • NON_PROVISIONABLE: The resource type doesn't include create, read, and delete handlers, and therefore can't actually be provisioned.

The default is FULLY_MUTABLE.

listTypes_visibility :: Lens' ListTypes (Maybe Visibility) Source #

The scope at which the extensions are visible and usable in CloudFormation operations.

Valid values include:

  • PRIVATE: Extensions that are visible and usable within this account and region. This includes:

    • Private extensions you have registered in this account and region.
    • Public extensions that you have activated in this account and region.
  • PUBLIC: Extensions that are publicly visible and available to be activated within any Amazon Web Services account. This includes extensions from Amazon Web Services, in addition to third-party publishers.

The default is PRIVATE.

Destructuring the Response

data ListTypesResponse Source #

See: newListTypesResponse smart constructor.

Constructors

ListTypesResponse' 

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.

  • typeSummaries :: Maybe [TypeSummary]

    A list of TypeSummary structures that contain information about the specified extensions.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListTypesResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ListTypes

Associated Types

type Rep ListTypesResponse :: Type -> Type #

Read ListTypesResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ListTypes

Show ListTypesResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ListTypes

NFData ListTypesResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ListTypes

Methods

rnf :: ListTypesResponse -> () #

Eq ListTypesResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ListTypes

type Rep ListTypesResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ListTypes

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

newListTypesResponse Source #

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

ListTypes, listTypesResponse_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:typeSummaries:ListTypesResponse', listTypesResponse_typeSummaries - A list of TypeSummary structures that contain information about the specified extensions.

$sel:httpStatus:ListTypesResponse', listTypesResponse_httpStatus - The response's http status code.

Response Lenses

listTypesResponse_nextToken :: Lens' ListTypesResponse (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.

listTypesResponse_typeSummaries :: Lens' ListTypesResponse (Maybe [TypeSummary]) Source #

A list of TypeSummary structures that contain information about the specified extensions.

listTypesResponse_httpStatus :: Lens' ListTypesResponse Int Source #

The response's http status code.