Class: Aws::CloudFormation::Types::ListTypeVersionsInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb

Overview

Note:

When making an API call, you may pass ListTypeVersionsInput data as a hash:

{
  type: "RESOURCE", # accepts RESOURCE
  type_name: "TypeName",
  arn: "PrivateTypeArn",
  max_results: 1,
  next_token: "NextToken",
  deprecated_status: "LIVE", # accepts LIVE, DEPRECATED
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

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.

Returns:

  • (String)


4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4116

class ListTypeVersionsInput < Struct.new(
  :type,
  :type_name,
  :arn,
  :max_results,
  :next_token,
  :deprecated_status)
  SENSITIVE = []
  include Aws::Structure
end

#deprecated_statusString

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.

Returns:

  • (String)


4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4116

class ListTypeVersionsInput < Struct.new(
  :type,
  :type_name,
  :arn,
  :max_results,
  :next_token,
  :deprecated_status)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

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.

Returns:

  • (Integer)


4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4116

class ListTypeVersionsInput < Struct.new(
  :type,
  :type_name,
  :arn,
  :max_results,
  :next_token,
  :deprecated_status)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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.

Returns:

  • (String)


4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4116

class ListTypeVersionsInput < Struct.new(
  :type,
  :type_name,
  :arn,
  :max_results,
  :next_token,
  :deprecated_status)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

The kind of the type.

Currently the only valid value is RESOURCE.

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

Returns:

  • (String)


4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4116

class ListTypeVersionsInput < Struct.new(
  :type,
  :type_name,
  :arn,
  :max_results,
  :next_token,
  :deprecated_status)
  SENSITIVE = []
  include Aws::Structure
end

#type_nameString

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

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

Returns:

  • (String)


4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4116

class ListTypeVersionsInput < Struct.new(
  :type,
  :type_name,
  :arn,
  :max_results,
  :next_token,
  :deprecated_status)
  SENSITIVE = []
  include Aws::Structure
end