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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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) 


6896
6897
6898
6899
6900
6901
6902
6903
 
# File 'gems/aws-sdk-lightsail/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>) 


6896
6897
6898
6899
6900
6901
6902
6903
 
# File 'gems/aws-sdk-lightsail/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) 


6896
6897
6898
6899
6900
6901
6902
6903
 
# File 'gems/aws-sdk-lightsail/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) 


6896
6897
6898
6899
6900
6901
6902
6903
 
# File 'gems/aws-sdk-lightsail/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