Amazonka.CloudFormation.ListTypes

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

This operation returns paginated results.

Creating a Request

data ListTypes

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

ToHeaders ListTypes

Defined in Amazonka.CloudFormation.ListTypes

Methods

toHeaders :: ListTypes -> [Header]

ToPath ListTypes

Defined in Amazonka.CloudFormation.ListTypes

Methods

toPath :: ListTypes -> ByteString

ToQuery ListTypes

Defined in Amazonka.CloudFormation.ListTypes

Methods

toQuery :: ListTypes -> QueryString

AWSPager ListTypes

Defined in Amazonka.CloudFormation.ListTypes

Methods

page :: ListTypes -> AWSResponse ListTypes -> Maybe ListTypes

AWSRequest ListTypes

Defined in Amazonka.CloudFormation.ListTypes

Associated Types

type AWSResponse ListTypes

Methods

request :: (Service -> Service) -> ListTypes -> Request ListTypes

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListTypes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListTypes)))

Generic ListTypes

Defined in Amazonka.CloudFormation.ListTypes

Associated Types

type Rep ListTypes :: Type -> Type

Methods

from :: ListTypes -> Rep ListTypes x

to :: Rep ListTypes x -> ListTypes

Read ListTypes

Defined in Amazonka.CloudFormation.ListTypes

Methods

readsPrec :: Int -> ReadS ListTypes

readList :: ReadS [ListTypes]

readPrec :: ReadPrec ListTypes

readListPrec :: ReadPrec [ListTypes]

Show ListTypes

Defined in Amazonka.CloudFormation.ListTypes

Methods

showsPrec :: Int -> ListTypes -> ShowS

show :: ListTypes -> String

showList :: [ListTypes] -> ShowS

NFData ListTypes

Defined in Amazonka.CloudFormation.ListTypes

Methods

rnf :: ListTypes -> ()

Eq ListTypes

Defined in Amazonka.CloudFormation.ListTypes

Methods

(==) :: ListTypes -> ListTypes -> Bool

(/=) :: ListTypes -> ListTypes -> Bool

Hashable ListTypes

Defined in Amazonka.CloudFormation.ListTypes

Methods

hashWithSalt :: Int -> ListTypes -> Int

hash :: ListTypes -> Int

type AWSResponse ListTypes

Defined in Amazonka.CloudFormation.ListTypes

type AWSResponse ListTypes = ListTypesResponse

type Rep ListTypes

Defined in Amazonka.CloudFormation.ListTypes

type Rep ListTypes = D1 ('MetaData "ListTypes" "Amazonka.CloudFormation.ListTypes" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "ListTypes'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "deprecatedStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeprecatedStatus)) :*: (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TypeFilters)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :*: ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "provisioningType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProvisioningType))) :*: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RegistryType)) :*: S1 ('MetaSel ('Just "visibility") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Visibility))))))

newListTypes :: ListTypes

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)

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)

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)

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)

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)

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_type :: Lens' ListTypes (Maybe RegistryType)

The type of extension.

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

Destructuring the Response

data ListTypesResponse

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

Generic ListTypesResponse

Defined in Amazonka.CloudFormation.ListTypes

Associated Types

type Rep ListTypesResponse :: Type -> Type

Methods

from :: ListTypesResponse -> Rep ListTypesResponse x

to :: Rep ListTypesResponse x -> ListTypesResponse

Read ListTypesResponse

Defined in Amazonka.CloudFormation.ListTypes

Methods

readsPrec :: Int -> ReadS ListTypesResponse

readList :: ReadS [ListTypesResponse]

readPrec :: ReadPrec ListTypesResponse

readListPrec :: ReadPrec [ListTypesResponse]

Show ListTypesResponse

Defined in Amazonka.CloudFormation.ListTypes

Methods

showsPrec :: Int -> ListTypesResponse -> ShowS

show :: ListTypesResponse -> String

showList :: [ListTypesResponse] -> ShowS

NFData ListTypesResponse

Defined in Amazonka.CloudFormation.ListTypes

Methods

rnf :: ListTypesResponse -> ()

Eq ListTypesResponse

Defined in Amazonka.CloudFormation.ListTypes

Methods

(==) :: ListTypesResponse -> ListTypesResponse -> Bool

(/=) :: ListTypesResponse -> ListTypesResponse -> Bool

type Rep ListTypesResponse

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

Arguments

:: Int

$sel:httpStatus:ListTypesResponse'

-> ListTypesResponse

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)

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

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

listTypesResponse_httpStatus :: Lens' ListTypesResponse Int

The response's http status code.