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

Inherits:

Struct

• Object
• Struct
• Aws::Lightsail::Types::GetCertificatesRequest

Includes:

Structure

Defined in:

lib/aws-sdk-lightsail/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #certificate_name ⇒ String

  The name for the certificate for which to return information.

• #certificate_statuses ⇒ Array<String>

  The status of the certificates for which to return information.

• #include_certificate_details ⇒ Boolean

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

• #page_token ⇒ String

  The token to advance to the next page of results from your request.

Instance Attribute Details

#certificate_name ⇒ String

The name for the certificate for which to return information.

When omitted, the response includes all of your certificates in the Amazon Web Services Region where the request is made.

Returns:

• (String)

# File 'lib/aws-sdk-lightsail/types.rb', line 6896

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

#certificate_statuses ⇒ Array<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 Amazon Web Services Region where the request is made, regardless of their current status.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-lightsail/types.rb', line 6896

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

#include_certificate_details ⇒ Boolean

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)

# File 'lib/aws-sdk-lightsail/types.rb', line 6896

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

#page_token ⇒ String

The token to advance to the next page of results from your request.

To get a page token, perform an initial ‘GetCertificates` request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

Returns:

• (String)

# File 'lib/aws-sdk-lightsail/types.rb', line 6896

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