cloudformation_list_type_versions: Returns summary information about the versions of a type

Description Usage Arguments Value Request syntax

View source: R/cloudformation_operations.R

Description

Returns summary information about the versions of a type.

Usage

1
2
cloudformation_list_type_versions(Type, TypeName, Arn, MaxResults,
  NextToken, DeprecatedStatus)

Arguments

Type

The kind of the type.

Currently the only valid value is RESOURCE.

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

TypeName

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

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

Arn

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

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

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.

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.

DeprecatedStatus

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

Valid values include:

  • LIVE: The type version is registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.

  • DEPRECATED: The type version has been deregistered and can no longer be used in CloudFormation operations.

The default is LIVE.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
list(
  TypeVersionSummaries = list(
    list(
      Type = "RESOURCE"|"MODULE",
      TypeName = "string",
      VersionId = "string",
      IsDefaultVersion = TRUE|FALSE,
      Arn = "string",
      TimeCreated = as.POSIXct(
        "2015-01-01"
      ),
      Description = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

1
2
3
4
5
6
7
8
svc$list_type_versions(
  Type = "RESOURCE"|"MODULE",
  TypeName = "string",
  Arn = "string",
  MaxResults = 123,
  NextToken = "string",
  DeprecatedStatus = "LIVE"|"DEPRECATED"
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.