You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::ACMPCA::Types::ListTagsRequest

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

Overview

Note:

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

{
  certificate_authority_arn: "Arn", # required
  next_token: "NextToken",
  max_results: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#certificate_authority_arnString

The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. This must be of the form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

Returns:

  • (String)


1303
1304
1305
1306
1307
1308
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 1303

class ListTagsRequest < Struct.new(
  :certificate_authority_arn,
  :next_token,
  :max_results)
  include Aws::Structure
end

#max_resultsInteger

Use this parameter when paginating results to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items.

Returns:

  • (Integer)


1303
1304
1305
1306
1307
1308
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 1303

class ListTagsRequest < Struct.new(
  :certificate_authority_arn,
  :next_token,
  :max_results)
  include Aws::Structure
end

#next_tokenString

Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the response you just received.

Returns:

  • (String)


1303
1304
1305
1306
1307
1308
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 1303

class ListTagsRequest < Struct.new(
  :certificate_authority_arn,
  :next_token,
  :max_results)
  include Aws::Structure
end