Class: Aws::CloudFormation::Types::ListTypeRegistrationsInput

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 ListTypeRegistrationsInput data as a hash:

{
  type: "RESOURCE", # accepts RESOURCE
  type_name: "TypeName",
  type_arn: "TypeArn",
  registration_status_filter: "COMPLETE", # accepts COMPLETE, IN_PROGRESS, FAILED
  max_results: 1,
  next_token: "NextToken",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

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


4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4011

class ListTypeRegistrationsInput < Struct.new(
  :type,
  :type_name,
  :type_arn,
  :registration_status_filter,
  :max_results,
  :next_token)
  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)


4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4011

class ListTypeRegistrationsInput < Struct.new(
  :type,
  :type_name,
  :type_arn,
  :registration_status_filter,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#registration_status_filterString

The current status of the type registration request.

The default is IN_PROGRESS.

Returns:

  • (String)


4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4011

class ListTypeRegistrationsInput < Struct.new(
  :type,
  :type_name,
  :type_arn,
  :registration_status_filter,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

The kind of type.

Currently the only valid value is RESOURCE.

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

Returns:

  • (String)


4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4011

class ListTypeRegistrationsInput < Struct.new(
  :type,
  :type_name,
  :type_arn,
  :registration_status_filter,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#type_arnString

The Amazon Resource Name (ARN) of the type.

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

Returns:

  • (String)


4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4011

class ListTypeRegistrationsInput < Struct.new(
  :type,
  :type_name,
  :type_arn,
  :registration_status_filter,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#type_nameString

The name of the type.

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

Returns:

  • (String)


4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4011

class ListTypeRegistrationsInput < Struct.new(
  :type,
  :type_name,
  :type_arn,
  :registration_status_filter,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end