AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

UpdateKeyDescriptionInput

import "github.com/aws/aws-sdk-go/service/kms"

type UpdateKeyDescriptionInput struct { Description *string `type:"string" required:"true"` KeyId *string `min:"1" type:"string" required:"true"` }

Description

Type: *string

New description for the CMK.

Description is a required field

KeyId

Type: *string

A unique identifier for the customer master key (CMK).

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

KeyId is a required field

Method

GoString

func (s UpdateKeyDescriptionInput) GoString() string

GoString returns the string representation

SetDescription

func (s *UpdateKeyDescriptionInput) SetDescription(v string) *UpdateKeyDescriptionInput

SetDescription sets the Description field's value.

SetKeyId

func (s *UpdateKeyDescriptionInput) SetKeyId(v string) *UpdateKeyDescriptionInput

SetKeyId sets the KeyId field's value.

String

func (s UpdateKeyDescriptionInput) String() string

String returns the string representation

Validate

func (s *UpdateKeyDescriptionInput) Validate() error

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

On this page: