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

Class: Aws::ACM::Types::ListCertificatesRequest

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

Overview

Note:

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

{
  certificate_statuses: ["PENDING_VALIDATION"], # accepts PENDING_VALIDATION, ISSUED, INACTIVE, EXPIRED, VALIDATION_TIMED_OUT, REVOKED, FAILED
  next_token: "NextToken",
  max_items: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#certificate_statusesArray<String>

The status or statuses on which to filter the list of ACM Certificates.

Returns:

  • (Array<String>)


528
529
530
531
532
533
# File 'gems/aws-sdk-acm/lib/aws-sdk-acm/types.rb', line 528

class ListCertificatesRequest < Struct.new(
  :certificate_statuses,
  :next_token,
  :max_items)
  include Aws::Structure
end

#max_itemsInteger

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)


528
529
530
531
532
533
# File 'gems/aws-sdk-acm/lib/aws-sdk-acm/types.rb', line 528

class ListCertificatesRequest < Struct.new(
  :certificate_statuses,
  :next_token,
  :max_items)
  include Aws::Structure
end

#next_tokenString

Use this parameter only when paginating results and only 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)


528
529
530
531
532
533
# File 'gems/aws-sdk-acm/lib/aws-sdk-acm/types.rb', line 528

class ListCertificatesRequest < Struct.new(
  :certificate_statuses,
  :next_token,
  :max_items)
  include Aws::Structure
end