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

Inherits:

Struct

• Object
• Struct
• Aws::ACM::Types::ListCertificatesRequest

Includes:

Structure

Defined in:

lib/aws-sdk-acm/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #certificate_statuses ⇒ Array<String>

  Filter the certificate list by status value.

• #includes ⇒ Types::Filters

  Filter the certificate list.

• #max_items ⇒ Integer

  Use this parameter when paginating results to specify the maximum number of items to return in the response.

• #next_token ⇒ String

  Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results.

• #sort_by ⇒ String

  Specifies the field to sort results by.

• #sort_order ⇒ String

  Specifies the order of sorted results.

Instance Attribute Details

#certificate_statuses ⇒ Array<String>

Filter the certificate list by status value.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-acm/types.rb', line 1033

class ListCertificatesRequest < Struct.new(
  :certificate_statuses,
  :includes,
  :next_token,
  :max_items,
  :sort_by,
  :sort_order)
  SENSITIVE = []
  include Aws::Structure
end

#includes ⇒ Types::Filters

Filter the certificate list. For more information, see the Filters structure.

Returns:

• (Types::Filters)

# File 'lib/aws-sdk-acm/types.rb', line 1033

class ListCertificatesRequest < Struct.new(
  :certificate_statuses,
  :includes,
  :next_token,
  :max_items,
  :sort_by,
  :sort_order)
  SENSITIVE = []
  include Aws::Structure
end

#max_items ⇒ Integer

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)

# File 'lib/aws-sdk-acm/types.rb', line 1033

class ListCertificatesRequest < Struct.new(
  :certificate_statuses,
  :includes,
  :next_token,
  :max_items,
  :sort_by,
  :sort_order)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

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)

# File 'lib/aws-sdk-acm/types.rb', line 1033

class ListCertificatesRequest < Struct.new(
  :certificate_statuses,
  :includes,
  :next_token,
  :max_items,
  :sort_by,
  :sort_order)
  SENSITIVE = []
  include Aws::Structure
end

#sort_by ⇒ String

Specifies the field to sort results by. If you specify ‘SortBy`, you must also specify `SortOrder`.

Returns:

• (String)

# File 'lib/aws-sdk-acm/types.rb', line 1033

class ListCertificatesRequest < Struct.new(
  :certificate_statuses,
  :includes,
  :next_token,
  :max_items,
  :sort_by,
  :sort_order)
  SENSITIVE = []
  include Aws::Structure
end

#sort_order ⇒ String

Specifies the order of sorted results. If you specify ‘SortOrder`, you must also specify `SortBy`.

Returns:

• (String)

# File 'lib/aws-sdk-acm/types.rb', line 1033

class ListCertificatesRequest < Struct.new(
  :certificate_statuses,
  :includes,
  :next_token,
  :max_items,
  :sort_by,
  :sort_order)
  SENSITIVE = []
  include Aws::Structure
end