Class: Aws::Redshift::Types::DescribeHsmClientCertificatesMessage

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-redshift/types.rb

Overview

Note:

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

{
  hsm_client_certificate_identifier: "String",
  max_records: 1,
  marker: "String",
  tag_keys: ["String"],
  tag_values: ["String"],
}

Instance Attribute Summary collapse

Instance Attribute Details

#hsm_client_certificate_identifierString

The identifier of a specific HSM client certificate for which you want information. If no identifier is specified, information is returned for all HSM client certificates owned by your AWS customer account.

Returns:

  • (String)


3813
3814
3815
3816
3817
3818
3819
3820
# File 'lib/aws-sdk-redshift/types.rb', line 3813

class DescribeHsmClientCertificatesMessage < Struct.new(
  :hsm_client_certificate_identifier,
  :max_records,
  :marker,
  :tag_keys,
  :tag_values)
  include Aws::Structure
end

#markerString

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeHsmClientCertificates request exceed the value specified in ‘MaxRecords`, AWS returns a value in the `Marker` field of the response. You can retrieve the next set of response records by providing the returned marker value in the `Marker` parameter and retrying the request.

Returns:

  • (String)


3813
3814
3815
3816
3817
3818
3819
3820
# File 'lib/aws-sdk-redshift/types.rb', line 3813

class DescribeHsmClientCertificatesMessage < Struct.new(
  :hsm_client_certificate_identifier,
  :max_records,
  :marker,
  :tag_keys,
  :tag_values)
  include Aws::Structure
end

#max_recordsInteger

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified ‘MaxRecords` value, a value is returned in a `marker` field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: ‘100`

Constraints: minimum 20, maximum 100.

Returns:

  • (Integer)


3813
3814
3815
3816
3817
3818
3819
3820
# File 'lib/aws-sdk-redshift/types.rb', line 3813

class DescribeHsmClientCertificatesMessage < Struct.new(
  :hsm_client_certificate_identifier,
  :max_records,
  :marker,
  :tag_keys,
  :tag_values)
  include Aws::Structure
end

#tag_keysArray<String>

A tag key or keys for which you want to return all matching HSM client certificates that are associated with the specified key or keys. For example, suppose that you have HSM client certificates that are tagged with keys called ‘owner` and `environment`. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the HSM client certificates that have either or both of these tag keys associated with them.

Returns:

  • (Array<String>)


3813
3814
3815
3816
3817
3818
3819
3820
# File 'lib/aws-sdk-redshift/types.rb', line 3813

class DescribeHsmClientCertificatesMessage < Struct.new(
  :hsm_client_certificate_identifier,
  :max_records,
  :marker,
  :tag_keys,
  :tag_values)
  include Aws::Structure
end

#tag_valuesArray<String>

A tag value or values for which you want to return all matching HSM client certificates that are associated with the specified tag value or values. For example, suppose that you have HSM client certificates that are tagged with values called ‘admin` and `test`. If you specify both of these tag values in the request, Amazon Redshift returns a response with the HSM client certificates that have either or both of these tag values associated with them.

Returns:

  • (Array<String>)


3813
3814
3815
3816
3817
3818
3819
3820
# File 'lib/aws-sdk-redshift/types.rb', line 3813

class DescribeHsmClientCertificatesMessage < Struct.new(
  :hsm_client_certificate_identifier,
  :max_records,
  :marker,
  :tag_keys,
  :tag_values)
  include Aws::Structure
end