Struct: kms.DescribeCustomKeyStoresInput

import "../ibm-cos-sdk-go/service/kms"

Implemented Interfaces

s3crypto.Cipher, s3manager.ReadSeekerWriteTo, request.Validator, s3manager.WriterReadFrom

Structure Field Summary

• CustomKeyStoreId *string

  Gets only information about the specified custom key store.

• CustomKeyStoreName *string

  Gets only information about the specified custom key store.

• Limit *int64

  Use this parameter to specify the maximum number of items to return.

• Marker *string

  Use this parameter in a subsequent request after you receive a response with truncated results.

• _ struct{}

Service Operations

• GoString() string operation

  GoString returns the string representation.

• SetCustomKeyStoreId(string) *DescribeCustomKeyStoresInput operation

  SetCustomKeyStoreId sets the CustomKeyStoreId field's value.

• SetCustomKeyStoreName(string) *DescribeCustomKeyStoresInput operation

  SetCustomKeyStoreName sets the CustomKeyStoreName field's value.

• SetLimit(int64) *DescribeCustomKeyStoresInput operation

  SetLimit sets the Limit field's value.

• SetMarker(string) *DescribeCustomKeyStoresInput operation

  SetMarker sets the Marker field's value.

• String() string operation

  String returns the string representation.

• Validate() error operation

  Validate inspects the fields of the type to determine if they are valid.

Structure Field Details

CustomKeyStoreId *string `min:"1" type:"string"`

Gets only information about the specified custom key store. Enter the key store ID.

By default, this operation gets information about all custom key stores in the account and Region. To limit the output to a particular custom key store, provide either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

CustomKeyStoreName *string `min:"1" type:"string"`

Gets only information about the specified custom key store. Enter the friendly name of the custom key store.

By default, this operation gets information about all custom key stores in the account and Region. To limit the output to a particular custom key store, provide either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

Limit *int64 `min:"1" type:"integer"`

Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.

Marker *string `min:"1" type:"string"`

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

_ struct{} `type:"structure"`

Method Details

func (s DescribeCustomKeyStoresInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as “sensitive” in the API will not be included in the string output. The member name will be present, but the value will be replaced with “sensitive”.

// File 'service/kms/api.go', line 10474

func (s DescribeCustomKeyStoresInput) GoString() string {
	return s.String()
}

func (s *DescribeCustomKeyStoresInput) SetCustomKeyStoreId(v string) *DescribeCustomKeyStoresInput

SetCustomKeyStoreId sets the CustomKeyStoreId field's value.

// File 'service/kms/api.go', line 10501

func (s *DescribeCustomKeyStoresInput) SetCustomKeyStoreId(v string) *DescribeCustomKeyStoresInput {
	s.CustomKeyStoreId = &v
	return s
}

func (s *DescribeCustomKeyStoresInput) SetCustomKeyStoreName(v string) *DescribeCustomKeyStoresInput

SetCustomKeyStoreName sets the CustomKeyStoreName field's value.

// File 'service/kms/api.go', line 10507

func (s *DescribeCustomKeyStoresInput) SetCustomKeyStoreName(v string) *DescribeCustomKeyStoresInput {
	s.CustomKeyStoreName = &v
	return s
}

func (s *DescribeCustomKeyStoresInput) SetLimit(v int64) *DescribeCustomKeyStoresInput

SetLimit sets the Limit field's value.

// File 'service/kms/api.go', line 10513

func (s *DescribeCustomKeyStoresInput) SetLimit(v int64) *DescribeCustomKeyStoresInput {
	s.Limit = &v
	return s
}

func (s *DescribeCustomKeyStoresInput) SetMarker(v string) *DescribeCustomKeyStoresInput

SetMarker sets the Marker field's value.

// File 'service/kms/api.go', line 10519

func (s *DescribeCustomKeyStoresInput) SetMarker(v string) *DescribeCustomKeyStoresInput {
	s.Marker = &v
	return s
}

func (s DescribeCustomKeyStoresInput) String() string

String returns the string representation.

API parameter values that are decorated as “sensitive” in the API will not be included in the string output. The member name will be present, but the value will be replaced with “sensitive”.

// File 'service/kms/api.go', line 10465

func (s DescribeCustomKeyStoresInput) String() string {
	return awsutil.Prettify(s)
}

func (s *DescribeCustomKeyStoresInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

// File 'service/kms/api.go', line 10479

func (s *DescribeCustomKeyStoresInput) Validate() error {
	invalidParams := request.ErrInvalidParams{Context: "DescribeCustomKeyStoresInput"}
	if s.CustomKeyStoreId != nil && len(*s.CustomKeyStoreId) < 1 {
		invalidParams.Add(request.NewErrParamMinLen("CustomKeyStoreId", 1))
	}
	if s.CustomKeyStoreName != nil && len(*s.CustomKeyStoreName) < 1 {
		invalidParams.Add(request.NewErrParamMinLen("CustomKeyStoreName", 1))
	}
	if s.Limit != nil && *s.Limit < 1 {
		invalidParams.Add(request.NewErrParamMinValue("Limit", 1))
	}
	if s.Marker != nil && len(*s.Marker) < 1 {
		invalidParams.Add(request.NewErrParamMinLen("Marker", 1))
	}

	if invalidParams.Len() > 0 {
		return invalidParams
	}
	return nil
}