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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListCertificatesRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  certificate_statuses: ["PENDING_VALIDATION"], # accepts PENDING_VALIDATION, ISSUED, INACTIVE, EXPIRED, VALIDATION_TIMED_OUT, REVOKED, FAILED
  includes: {
    extended_key_usage: ["TLS_WEB_SERVER_AUTHENTICATION"], # accepts TLS_WEB_SERVER_AUTHENTICATION, TLS_WEB_CLIENT_AUTHENTICATION, CODE_SIGNING, EMAIL_PROTECTION, TIME_STAMPING, OCSP_SIGNING, IPSEC_END_SYSTEM, IPSEC_TUNNEL, IPSEC_USER, ANY, NONE, CUSTOM
    key_usage: ["DIGITAL_SIGNATURE"], # accepts DIGITAL_SIGNATURE, NON_REPUDIATION, KEY_ENCIPHERMENT, DATA_ENCIPHERMENT, KEY_AGREEMENT, CERTIFICATE_SIGNING, CRL_SIGNING, ENCIPHER_ONLY, DECIPHER_ONLY, ANY, CUSTOM
    key_types: ["RSA_2048"], # accepts RSA_2048, RSA_1024, RSA_4096, EC_prime256v1, EC_secp384r1, EC_secp521r1
  },
  next_token: "NextToken",
  max_items: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#certificate_statusesArray<String>

Filter the certificate list by status value.

Returns:

  • (Array<String>)

    Filter the certificate list by status value.

#includesTypes::Filters

Filter the certificate list by one or more of the following values. For more information, see the Filters structure.

  • extendedKeyUsage

  • keyUsage

  • keyTypes

Returns:

  • (Types::Filters)

    Filter the certificate list by one or more of the following values.

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

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

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

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