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

Class: Aws::ACMPCA::Types::ListPermissionsRequest

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 ListPermissionsRequest 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 Number (ARN) of the private CA to inspect. You can find the ARN by calling the ListCertificateAuthorities action. This must be of the form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 You can get a private CA's ARN by running the ListCertificateAuthorities action.

Returns:

  • (String)


1244
1245
1246
1247
1248
1249
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 1244

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

#max_resultsInteger

When paginating results, use this parameter 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)


1244
1245
1246
1247
1248
1249
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 1244

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

#next_tokenString

When paginating results, use this parameter 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)


1244
1245
1246
1247
1248
1249
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 1244

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