Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CloudFormation.ListTypeVersions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns summary information about the versions of an extension.

Synopsis

data ListTypeVersions = ListTypeVersions' {
- typeName :: Maybe Text
- arn :: Maybe Text
- nextToken :: Maybe Text
- deprecatedStatus :: Maybe DeprecatedStatus
- type' :: Maybe RegistryType
- publisherId :: Maybe Text
- maxResults :: Maybe Natural
}
newListTypeVersions :: ListTypeVersions
listTypeVersions_typeName :: Lens' ListTypeVersions (Maybe Text)
listTypeVersions_arn :: Lens' ListTypeVersions (Maybe Text)
listTypeVersions_nextToken :: Lens' ListTypeVersions (Maybe Text)
listTypeVersions_deprecatedStatus :: Lens' ListTypeVersions (Maybe DeprecatedStatus)
listTypeVersions_type :: Lens' ListTypeVersions (Maybe RegistryType)
listTypeVersions_publisherId :: Lens' ListTypeVersions (Maybe Text)
listTypeVersions_maxResults :: Lens' ListTypeVersions (Maybe Natural)
data ListTypeVersionsResponse = ListTypeVersionsResponse' {
- nextToken :: Maybe Text
- typeVersionSummaries :: Maybe [TypeVersionSummary]
- httpStatus :: Int
}
newListTypeVersionsResponse :: Int -> ListTypeVersionsResponse
listTypeVersionsResponse_nextToken :: Lens' ListTypeVersionsResponse (Maybe Text)
listTypeVersionsResponse_typeVersionSummaries :: Lens' ListTypeVersionsResponse (Maybe [TypeVersionSummary])
listTypeVersionsResponse_httpStatus :: Lens' ListTypeVersionsResponse Int

Creating a Request

data ListTypeVersions Source #

See: newListTypeVersions smart constructor.

Constructors

ListTypeVersions'

Fields

typeName :: Maybe Text
The name of the extension for which you want version summary information.
Conditional: You must specify either TypeName and Type, or Arn.
arn :: Maybe Text
The Amazon Resource Name (ARN) of the extension for which you want version summary information.
Conditional: You must specify either TypeName and Type, or Arn.
nextToken :: Maybe Text
If the previous paginated request didn't return all of 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.
deprecatedStatus :: Maybe DeprecatedStatus
The deprecation status of the extension versions that you want to get summary information about.
Valid values include:
- LIVE: The extension version is registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.
- DEPRECATED: The extension version has been deregistered and can no longer be used in CloudFormation operations.
The default is LIVE.
type' :: Maybe RegistryType
The kind of the extension.
Conditional: You must specify either TypeName and Type, or Arn.
publisherId :: Maybe Text
The publisher ID of the extension publisher.
Extensions published by Amazon are not assigned a publisher ID.
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.

Instances

Instances details

Eq ListTypeVersions Source #
Instance details Defined in Amazonka.CloudFormation.ListTypeVersions Methods (==) :: ListTypeVersions -> ListTypeVersions -> Bool # (/=) :: ListTypeVersions -> ListTypeVersions -> Bool #
Read ListTypeVersions Source #
Instance details Defined in Amazonka.CloudFormation.ListTypeVersions Methods readsPrec :: Int -> ReadS ListTypeVersions # readList :: ReadS [ListTypeVersions] # readPrec :: ReadPrec ListTypeVersions # readListPrec :: ReadPrec [ListTypeVersions] #
Show ListTypeVersions Source #
Instance details Defined in Amazonka.CloudFormation.ListTypeVersions Methods showsPrec :: Int -> ListTypeVersions -> ShowS # show :: ListTypeVersions -> String # showList :: [ListTypeVersions] -> ShowS #
Generic ListTypeVersions Source #
Instance details Defined in Amazonka.CloudFormation.ListTypeVersions Associated Types type Rep ListTypeVersions :: Type -> Type # Methods from :: ListTypeVersions -> Rep ListTypeVersions x # to :: Rep ListTypeVersions x -> ListTypeVersions #
NFData ListTypeVersions Source #
Instance details Defined in Amazonka.CloudFormation.ListTypeVersions Methods rnf :: ListTypeVersions -> () #
Hashable ListTypeVersions Source #
Instance details Defined in Amazonka.CloudFormation.ListTypeVersions Methods hashWithSalt :: Int -> ListTypeVersions -> Int # hash :: ListTypeVersions -> Int #
AWSRequest ListTypeVersions Source #
Instance details Defined in Amazonka.CloudFormation.ListTypeVersions Associated Types type AWSResponse ListTypeVersions # Methods request :: ListTypeVersions -> Request ListTypeVersions # response :: MonadResource m => Logger -> Service -> Proxy ListTypeVersions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListTypeVersions))) #
ToHeaders ListTypeVersions Source #
Instance details Defined in Amazonka.CloudFormation.ListTypeVersions Methods toHeaders :: ListTypeVersions -> [Header] #
ToPath ListTypeVersions Source #
Instance details Defined in Amazonka.CloudFormation.ListTypeVersions Methods toPath :: ListTypeVersions -> ByteString #
ToQuery ListTypeVersions Source #
Instance details Defined in Amazonka.CloudFormation.ListTypeVersions Methods toQuery :: ListTypeVersions -> QueryString #
type Rep ListTypeVersions Source #
Instance details Defined in Amazonka.CloudFormation.ListTypeVersions type Rep ListTypeVersions = D1 ('MetaData "ListTypeVersions" "Amazonka.CloudFormation.ListTypeVersions" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" 'False) (C1 ('MetaCons "ListTypeVersions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "typeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "deprecatedStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeprecatedStatus)) :: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RegistryType))) :: (S1 ('MetaSel ('Just "publisherId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))))
type AWSResponse ListTypeVersions Source #
Instance details Defined in Amazonka.CloudFormation.ListTypeVersions type AWSResponse ListTypeVersions = ListTypeVersionsResponse

newListTypeVersions :: ListTypeVersions Source #

Create a value of ListTypeVersions 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:typeName:ListTypeVersions', listTypeVersions_typeName - The name of the extension for which you want version summary information.

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

$sel:arn:ListTypeVersions', listTypeVersions_arn - The Amazon Resource Name (ARN) of the extension for which you want version summary information.

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

$sel:nextToken:ListTypeVersions', listTypeVersions_nextToken - If the previous paginated request didn't return all of 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:deprecatedStatus:ListTypeVersions', listTypeVersions_deprecatedStatus - The deprecation status of the extension versions that you want to get summary information about.

Valid values include:

LIVE: The extension version is registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.
DEPRECATED: The extension version has been deregistered and can no longer be used in CloudFormation operations.

The default is LIVE.

$sel:type':ListTypeVersions', listTypeVersions_type - The kind of the extension.

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

$sel:publisherId:ListTypeVersions', listTypeVersions_publisherId - The publisher ID of the extension publisher.

Extensions published by Amazon are not assigned a publisher ID.

$sel:maxResults:ListTypeVersions', listTypeVersions_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.

Request Lenses

listTypeVersions_typeName :: Lens' ListTypeVersions (Maybe Text) Source #

The name of the extension for which you want version summary information.

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

listTypeVersions_arn :: Lens' ListTypeVersions (Maybe Text) Source #

The Amazon Resource Name (ARN) of the extension for which you want version summary information.

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

listTypeVersions_nextToken :: Lens' ListTypeVersions (Maybe Text) Source #

If the previous paginated request didn't return all of 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.

listTypeVersions_deprecatedStatus :: Lens' ListTypeVersions (Maybe DeprecatedStatus) Source #

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

Valid values include:

LIVE: The extension version is registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.
DEPRECATED: The extension version has been deregistered and can no longer be used in CloudFormation operations.

The default is LIVE.

listTypeVersions_type :: Lens' ListTypeVersions (Maybe RegistryType) Source #

The kind of the extension.

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

listTypeVersions_publisherId :: Lens' ListTypeVersions (Maybe Text) Source #

The publisher ID of the extension publisher.

Extensions published by Amazon are not assigned a publisher ID.

listTypeVersions_maxResults :: Lens' ListTypeVersions (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.

Destructuring the Response

data ListTypeVersionsResponse Source #

See: newListTypeVersionsResponse smart constructor.

Constructors

ListTypeVersionsResponse'

Fields

nextToken :: Maybe Text
If the request doesn't return all of 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.
typeVersionSummaries :: Maybe [TypeVersionSummary]
A list of TypeVersionSummary structures that contain information about the specified extension's versions.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq ListTypeVersionsResponse Source #
Instance details Defined in Amazonka.CloudFormation.ListTypeVersions Methods (==) :: ListTypeVersionsResponse -> ListTypeVersionsResponse -> Bool # (/=) :: ListTypeVersionsResponse -> ListTypeVersionsResponse -> Bool #
Read ListTypeVersionsResponse Source #
Instance details Defined in Amazonka.CloudFormation.ListTypeVersions Methods readsPrec :: Int -> ReadS ListTypeVersionsResponse # readList :: ReadS [ListTypeVersionsResponse] # readPrec :: ReadPrec ListTypeVersionsResponse # readListPrec :: ReadPrec [ListTypeVersionsResponse] #
Show ListTypeVersionsResponse Source #
Instance details Defined in Amazonka.CloudFormation.ListTypeVersions Methods showsPrec :: Int -> ListTypeVersionsResponse -> ShowS # show :: ListTypeVersionsResponse -> String # showList :: [ListTypeVersionsResponse] -> ShowS #
Generic ListTypeVersionsResponse Source #
Instance details Defined in Amazonka.CloudFormation.ListTypeVersions Associated Types type Rep ListTypeVersionsResponse :: Type -> Type # Methods from :: ListTypeVersionsResponse -> Rep ListTypeVersionsResponse x # to :: Rep ListTypeVersionsResponse x -> ListTypeVersionsResponse #
NFData ListTypeVersionsResponse Source #
Instance details Defined in Amazonka.CloudFormation.ListTypeVersions Methods rnf :: ListTypeVersionsResponse -> () #
type Rep ListTypeVersionsResponse Source #
Instance details Defined in Amazonka.CloudFormation.ListTypeVersions type Rep ListTypeVersionsResponse = D1 ('MetaData "ListTypeVersionsResponse" "Amazonka.CloudFormation.ListTypeVersions" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" 'False) (C1 ('MetaCons "ListTypeVersionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "typeVersionSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TypeVersionSummary])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListTypeVersionsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListTypeVersionsResponse'`
-> ListTypeVersionsResponse

Create a value of ListTypeVersionsResponse 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:nextToken:ListTypeVersions', listTypeVersionsResponse_nextToken - If the request doesn't return all of 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:typeVersionSummaries:ListTypeVersionsResponse', listTypeVersionsResponse_typeVersionSummaries - A list of TypeVersionSummary structures that contain information about the specified extension's versions.

$sel:httpStatus:ListTypeVersionsResponse', listTypeVersionsResponse_httpStatus - The response's http status code.

Response Lenses

listTypeVersionsResponse_nextToken :: Lens' ListTypeVersionsResponse (Maybe Text) Source #

If the request doesn't return all of 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.

listTypeVersionsResponse_typeVersionSummaries :: Lens' ListTypeVersionsResponse (Maybe [TypeVersionSummary]) Source #

A list of TypeVersionSummary structures that contain information about the specified extension's versions.

listTypeVersionsResponse_httpStatus :: Lens' ListTypeVersionsResponse Int Source #

The response's http status code.