AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::DocDB::Types::DescribeCertificatesMessage

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

Overview

Note:

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

{
  certificate_identifier: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  max_records: 1,
  marker: "String",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#certificate_identifierString

The user-supplied certificate identifier. If this parameter is specified, information for only the specified certificate is returned. If this parameter is omitted, a list of up to MaxRecords certificates is returned. This parameter is not case sensitive.

Constraints

  • Must match an existing CertificateIdentifier.

^

Returns:

  • (String)


2666
2667
2668
2669
2670
2671
2672
2673
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 2666

class DescribeCertificatesMessage < Struct.new(
  :certificate_identifier,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end

#filtersArray<Types::Filter>

This parameter is not currently supported.

Returns:



2666
2667
2668
2669
2670
2671
2672
2673
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 2666

class DescribeCertificatesMessage < Struct.new(
  :certificate_identifier,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end

#markerString

An optional pagination token provided by a previous DescribeCertificates request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Returns:

  • (String)


2666
2667
2668
2669
2670
2671
2672
2673
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 2666

class DescribeCertificatesMessage < Struct.new(
  :certificate_identifier,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end

#max_recordsInteger

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints:

  • Minimum: 20

  • Maximum: 100

Returns:

  • (Integer)


2666
2667
2668
2669
2670
2671
2672
2673
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 2666

class DescribeCertificatesMessage < Struct.new(
  :certificate_identifier,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end