Class: Aws::Lightsail::Types::GetCertificatesRequest

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

Overview

Note:

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

{
  certificate_statuses: ["PENDING_VALIDATION"], # accepts PENDING_VALIDATION, ISSUED, INACTIVE, EXPIRED, VALIDATION_TIMED_OUT, REVOKED, FAILED
  include_certificate_details: false,
  certificate_name: "CertificateName",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#certificate_nameString

The name for the certificate for which to return information.

When omitted, the response includes all of your certificates in the AWS region where the request is made.

Returns:

  • (String)


5324
5325
5326
5327
5328
5329
5330
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 5324

class GetCertificatesRequest < Struct.new(
  :certificate_statuses,
  :include_certificate_details,
  :certificate_name)
  SENSITIVE = []
  include Aws::Structure
end

#certificate_statusesArray<String>

The status of the certificates for which to return information.

For example, specify ISSUED to return only certificates with an ISSUED status.

When omitted, the response includes all of your certificates in the AWS region where the request is made, regardless of their current status.

Returns:

  • (Array<String>)


5324
5325
5326
5327
5328
5329
5330
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 5324

class GetCertificatesRequest < Struct.new(
  :certificate_statuses,
  :include_certificate_details,
  :certificate_name)
  SENSITIVE = []
  include Aws::Structure
end

#include_certificate_detailsBoolean

Indicates whether to include detailed information about the certificates in the response.

When omitted, the response includes only the certificate names, Amazon Resource Names (ARNs), domain names, and tags.

Returns:

  • (Boolean)


5324
5325
5326
5327
5328
5329
5330
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 5324

class GetCertificatesRequest < Struct.new(
  :certificate_statuses,
  :include_certificate_details,
  :certificate_name)
  SENSITIVE = []
  include Aws::Structure
end