Help us shape the future of Go! Take the 2026 Go Developer Survey

kms

package
v1.9.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 27, 2026 License: MIT Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client calls kms over its wire protocol.

func NewFromConfig

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a Client for cfg.

func (*Client) CreateAlias

func (c *Client) CreateAlias(ctx context.Context, in *CreateAliasInput) (*CreateAliasOutput, error)

CreateAlias calls the CreateAlias operation.

func (*Client) CreateKey

func (c *Client) CreateKey(ctx context.Context, in *CreateKeyInput) (*CreateKeyOutput, error)

CreateKey calls the CreateKey operation.

func (*Client) Decrypt

func (c *Client) Decrypt(ctx context.Context, in *DecryptInput) (*DecryptOutput, error)

Decrypt calls the Decrypt operation.

func (*Client) DescribeKey

func (c *Client) DescribeKey(ctx context.Context, in *DescribeKeyInput) (*DescribeKeyOutput, error)

DescribeKey calls the DescribeKey operation.

func (*Client) DisableKey

func (c *Client) DisableKey(ctx context.Context, in *DisableKeyInput) (*DisableKeyOutput, error)

DisableKey calls the DisableKey operation.

func (*Client) DisableKeyRotation

func (c *Client) DisableKeyRotation(ctx context.Context, in *DisableKeyRotationInput) (*DisableKeyRotationOutput, error)

DisableKeyRotation calls the DisableKeyRotation operation.

func (*Client) EnableKey

func (c *Client) EnableKey(ctx context.Context, in *EnableKeyInput) (*EnableKeyOutput, error)

EnableKey calls the EnableKey operation.

func (*Client) EnableKeyRotation

func (c *Client) EnableKeyRotation(ctx context.Context, in *EnableKeyRotationInput) (*EnableKeyRotationOutput, error)

EnableKeyRotation calls the EnableKeyRotation operation.

func (*Client) GetKeyPolicy

func (c *Client) GetKeyPolicy(ctx context.Context, in *GetKeyPolicyInput) (*GetKeyPolicyOutput, error)

GetKeyPolicy calls the GetKeyPolicy operation.

func (*Client) GetKeyRotationStatus

func (c *Client) GetKeyRotationStatus(ctx context.Context, in *GetKeyRotationStatusInput) (*GetKeyRotationStatusOutput, error)

GetKeyRotationStatus calls the GetKeyRotationStatus operation.

func (*Client) ListAliases

func (c *Client) ListAliases(ctx context.Context, in *ListAliasesInput) (*ListAliasesOutput, error)

ListAliases calls the ListAliases operation.

func (*Client) ListKeys

func (c *Client) ListKeys(ctx context.Context, in *ListKeysInput) (*ListKeysOutput, error)

ListKeys calls the ListKeys operation.

func (*Client) ListResourceTags

func (c *Client) ListResourceTags(ctx context.Context, in *ListResourceTagsInput) (*ListResourceTagsOutput, error)

ListResourceTags calls the ListResourceTags operation.

func (*Client) PutKeyPolicy

func (c *Client) PutKeyPolicy(ctx context.Context, in *PutKeyPolicyInput) (*PutKeyPolicyOutput, error)

PutKeyPolicy calls the PutKeyPolicy operation.

func (*Client) ScheduleKeyDeletion

func (c *Client) ScheduleKeyDeletion(ctx context.Context, in *ScheduleKeyDeletionInput) (*ScheduleKeyDeletionOutput, error)

ScheduleKeyDeletion calls the ScheduleKeyDeletion operation.

func (*Client) TagResource

func (c *Client) TagResource(ctx context.Context, in *TagResourceInput) (*TagResourceOutput, error)

TagResource calls the TagResource operation.

func (*Client) UntagResource

func (c *Client) UntagResource(ctx context.Context, in *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource calls the UntagResource operation.

func (*Client) UpdateAlias

func (c *Client) UpdateAlias(ctx context.Context, in *UpdateAliasInput) (*UpdateAliasOutput, error)

UpdateAlias calls the UpdateAlias operation.

func (*Client) UpdateKeyDescription

func (c *Client) UpdateKeyDescription(ctx context.Context, in *UpdateKeyDescriptionInput) (*UpdateKeyDescriptionOutput, error)

UpdateKeyDescription calls the UpdateKeyDescription operation.

type CreateAliasInput

type CreateAliasInput struct {
	AliasName   *string
	TargetKeyId *string
}

type CreateAliasOutput

type CreateAliasOutput struct {
}

type CreateKeyInput

type CreateKeyInput struct {
	BypassPolicyLockoutSafetyCheck bool `json:",omitempty"`
	CustomKeyStoreId               *string
	CustomerMasterKeySpec          types.CustomerMasterKeySpec `json:",omitempty"`
	Description                    *string
	KeySpec                        types.KeySpec      `json:",omitempty"`
	KeyUsage                       types.KeyUsageType `json:",omitempty"`
	MultiRegion                    *bool
	Origin                         types.OriginType `json:",omitempty"`
	Policy                         *string
	Tags                           []types.Tag
	XksKeyId                       *string
}

type CreateKeyOutput

type CreateKeyOutput struct {
	KeyMetadata *types.KeyMetadata
}

type DecryptInput

type DecryptInput struct {
	CiphertextBlob      []byte
	DryRun              *bool
	DryRunModifiers     []types.DryRunModifierType
	EncryptionAlgorithm types.EncryptionAlgorithmSpec `json:",omitempty"`
	EncryptionContext   map[string]string
	GrantTokens         []string
	KeyId               *string
	Recipient           *types.RecipientInfo
}

type DecryptOutput

type DecryptOutput struct {
	CiphertextForRecipient []byte
	EncryptionAlgorithm    types.EncryptionAlgorithmSpec
	KeyId                  *string
	KeyMaterialId          *string
	Plaintext              []byte
}

type DescribeKeyInput

type DescribeKeyInput struct {
	KeyId       *string
	GrantTokens []string
}

type DescribeKeyOutput

type DescribeKeyOutput struct {
	KeyMetadata *types.KeyMetadata
}

type DisableKeyInput

type DisableKeyInput struct {
	KeyId *string
}

type DisableKeyOutput

type DisableKeyOutput struct {
}

type DisableKeyRotationInput

type DisableKeyRotationInput struct {
	KeyId *string
}

type DisableKeyRotationOutput

type DisableKeyRotationOutput struct {
}

type EnableKeyInput

type EnableKeyInput struct {
	KeyId *string
}

type EnableKeyOutput

type EnableKeyOutput struct {
}

type EnableKeyRotationInput

type EnableKeyRotationInput struct {
	KeyId                *string
	RotationPeriodInDays *int32
}

type EnableKeyRotationOutput

type EnableKeyRotationOutput struct {
}

type GetKeyPolicyInput

type GetKeyPolicyInput struct {
	KeyId      *string
	PolicyName *string
}

type GetKeyPolicyOutput

type GetKeyPolicyOutput struct {
	Policy     *string
	PolicyName *string
}

type GetKeyRotationStatusInput

type GetKeyRotationStatusInput struct {
	KeyId *string
}

type GetKeyRotationStatusOutput

type GetKeyRotationStatusOutput struct {
	KeyId                     *string
	KeyRotationEnabled        bool
	NextRotationDate          *time.Time
	OnDemandRotationStartDate *time.Time
	RotationPeriodInDays      *int32
}

type ListAliasesInput

type ListAliasesInput struct {
	KeyId  *string
	Limit  *int32
	Marker *string
}

type ListAliasesOutput

type ListAliasesOutput struct {
	Aliases    []types.AliasListEntry
	NextMarker *string
	Truncated  bool
}

type ListAliasesPaginator

type ListAliasesPaginator = awswire.Paginator[ListAliasesInput, ListAliasesOutput]

ListAliasesPaginator pages through ListAliases.

func NewListAliasesPaginator

func NewListAliasesPaginator(c *Client, in *ListAliasesInput) *ListAliasesPaginator

NewListAliasesPaginator returns a paginator over ListAliases.

type ListKeysInput

type ListKeysInput struct {
	Limit  *int32
	Marker *string
}

type ListKeysOutput

type ListKeysOutput struct {
	Keys       []types.KeyListEntry
	NextMarker *string
	Truncated  bool
}

type ListKeysPaginator

type ListKeysPaginator = awswire.Paginator[ListKeysInput, ListKeysOutput]

ListKeysPaginator pages through ListKeys.

func NewListKeysPaginator

func NewListKeysPaginator(c *Client, in *ListKeysInput) *ListKeysPaginator

NewListKeysPaginator returns a paginator over ListKeys.

type ListResourceTagsInput

type ListResourceTagsInput struct {
	KeyId  *string
	Limit  *int32
	Marker *string
}

type ListResourceTagsOutput

type ListResourceTagsOutput struct {
	NextMarker *string
	Tags       []types.Tag
	Truncated  bool
}

type Options

type Options = awswire.Options

Options configures a Client.

type PutKeyPolicyInput

type PutKeyPolicyInput struct {
	KeyId                          *string
	Policy                         *string
	BypassPolicyLockoutSafetyCheck bool `json:",omitempty"`
	PolicyName                     *string
}

type PutKeyPolicyOutput

type PutKeyPolicyOutput struct {
}

type ScheduleKeyDeletionInput

type ScheduleKeyDeletionInput struct {
	KeyId               *string
	PendingWindowInDays *int32
}

type ScheduleKeyDeletionOutput

type ScheduleKeyDeletionOutput struct {
	DeletionDate        *time.Time
	KeyId               *string
	KeyState            types.KeyState
	PendingWindowInDays *int32
}

type TagResourceInput

type TagResourceInput struct {
	KeyId *string
	Tags  []types.Tag
}

type TagResourceOutput

type TagResourceOutput struct {
}

type UntagResourceInput

type UntagResourceInput struct {
	KeyId   *string
	TagKeys []string
}

type UntagResourceOutput

type UntagResourceOutput struct {
}

type UpdateAliasInput

type UpdateAliasInput struct {
	AliasName   *string
	TargetKeyId *string
}

type UpdateAliasOutput

type UpdateAliasOutput struct {
}

type UpdateKeyDescriptionInput

type UpdateKeyDescriptionInput struct {
	Description *string
	KeyId       *string
}

type UpdateKeyDescriptionOutput

type UpdateKeyDescriptionOutput struct {
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL