ISecretsManagerClient

Interface in AWS.SecretsManager

Interface for Secrets Manager service client.

Methods

CancelRotateSecret

function CancelRotateSecret( const ARequest: ISecretsManagerCancelRotateSecretRequest): ISecretsManagerCancelRotateSecretResponse; overload;

ISecretsManagerCancelRotateSecretRequest → ISecretsManagerCancelRotateSecretResponse

Cancel automatic rotation of a secret.

Parameters

Name	Description
ARequest	A CancelRotateSecret request object.

Returns

Response containing CancelRotateSecret results.

---

function CancelRotateSecret( const ASecretId: string): ISecretsManagerCancelRotateSecretResponse; overload;

ISecretsManagerCancelRotateSecretResponse

Cancel automatic rotation of a secret.

Parameters

Name	Description
ASecretId	Specify the identifier of the secret to cancel rotation for.

Returns

Response containing CancelRotateSecret results.

CreateSecret

function CreateSecret( const ARequest: ISecretsManagerCreateSecretRequest): ISecretsManagerCreateSecretResponse;

ISecretsManagerCreateSecretRequest → ISecretsManagerCreateSecretResponse

Create a new secret.

Parameters

Name	Description
ARequest	A CreateSecret request object.

Returns

Response containing CreateSecret results.

DeleteResourcePolicy

function DeleteResourcePolicy( const ARequest: ISecretsManagerDeleteResourcePolicyRequest): ISecretsManagerDeleteResourcePolicyResponse; overload;

ISecretsManagerDeleteResourcePolicyRequest → ISecretsManagerDeleteResourcePolicyResponse

Delete the resource-based permission policy attached to the secret.

Parameters

Name	Description
ARequest	A DeleteResourcePolicy request object.

Returns

Response containing DeleteResourcePolicy results.

---

function DeleteResourcePolicy( const ASecretId: string): ISecretsManagerDeleteResourcePolicyResponse; overload;

ISecretsManagerDeleteResourcePolicyResponse

Delete the resource-based permission policy attached to the secret.

Parameters

Name	Description
ASecretId	Specify the Amazon Resource Name (ARN) or name of the secret to delete the attached resource-based policy for.

Returns

Response containing DeleteResourcePolicy results.

DeleteSecret

function DeleteSecret( const ARequest: ISecretsManagerDeleteSecretRequest): ISecretsManagerDeleteSecretResponse;

ISecretsManagerDeleteSecretRequest → ISecretsManagerDeleteSecretResponse

Delete a secret and all of its versions.

Parameters

Name	Description
ARequest	A DeleteSecret request object.

Returns

Response containing DeleteSecret results.

DescribeSecret

function DescribeSecret( const ARequest: ISecretsManagerDescribeSecretRequest): ISecretsManagerDescribeSecretResponse; overload;

ISecretsManagerDescribeSecretRequest → ISecretsManagerDescribeSecretResponse

Fetch the details of a secret.

Parameters

Name	Description
ARequest	A DescribeSecret request object.

Returns

Response containing DescribeSecret results.

---

function DescribeSecret( const ASecretId: string): ISecretsManagerDescribeSecretResponse; overload;

ISecretsManagerDescribeSecretResponse

Fetch the details of a secret.

Parameters

Name	Description
ASecret	Specify the Amazon Resource Name (ARN) or name of the secret to retrieve.

Returns

Response containing DescribeSecret results.

GetRandomPassword

function GetRandomPassword( const ARequest: ISecretsManagerGetRandomPasswordRequest): ISecretsManagerGetRandomPasswordResponse; overload;

ISecretsManagerGetRandomPasswordRequest → ISecretsManagerGetRandomPasswordResponse

Generate a random password.

Parameters

Name	Description
ARequest	A GetRandomPassword request object.

Returns

Response containing GetRandomPassword results.

---

function GetRandomPassword: ISecretsManagerGetRandomPasswordResponse; overload;

ISecretsManagerGetRandomPasswordResponse

Generate a random password.

Returns

Response containing GetRandomPassword results.

GetResourcePolicy

function GetResourcePolicy( const ARequest: ISecretsManagerGetResourcePolicyRequest): ISecretsManagerGetResourcePolicyResponse; overload;

ISecretsManagerGetResourcePolicyRequest → ISecretsManagerGetResourcePolicyResponse

Fetch the JSON text of the resource-based policy document attached to the secret.

Parameters

Name	Description
ARequest	A GetResourcePolicy request object.

Returns

Response containing GetResourcePolicy results.

---

function GetResourcePolicy( const ASecretId: string): ISecretsManagerGetResourcePolicyResponse; overload;

ISecretsManagerGetResourcePolicyResponse

Fetch the JSON text of the resource-based policy document attached to the secret.

Parameters

Name	Description
ASecretId	Specify the Amazon Resource Name (ARN) or name of the secret to retreive the attached resource-based policy for.

Returns

Response containing GetResourcePolicy results.

GetSecretValue

function GetSecretValue( const ARequest: ISecretsManagerGetSecretValueRequest): ISecretsManagerGetSecretValueResponse; overload;

ISecretsManagerGetSecretValueRequest → ISecretsManagerGetSecretValueResponse

Fetch the contents of the encrypted fields SecretString or SecretBinary from the specified version of the secret.

Parameters

Name	Description
ARequest	A GetSecretValue request object.

Returns

Response containing GetSecretValue results.

---

function GetSecretValue( const ASecretId: string; const AVersionId: string = ''; const AVersionStage: string = ''): ISecretsManagerGetSecretValueResponse; overload;

ISecretsManagerGetSecretValueResponse

Fetch the contents of the encrypted fields SecretString or SecretBinary from the specified version of the secret.

Parameters

Name	Description
ASecretId	Specify the Amazon Resource Name (ARN) or name of the secret to retreive.
AVersionId	Specify the unique identifier of the version of a secret to retreive.
AVersionStage	Specify the staging label of the version of a secret to retreive.

Returns

Response containing GetSecretValue results.

ListSecrets

function ListSecrets( const ARequest: ISecretsManagerListSecretsRequest): ISecretsManagerListSecretsResponse; overload;

ISecretsManagerListSecretsRequest → ISecretsManagerListSecretsResponse

List the secrets that are stored by Secrets Manager.

Parameters

Name	Description
ARequest	A ListSecrets request object.

Returns

Response containing ListSecrets results.

---

function ListSecrets: ISecretsManagerListSecretsResponse; overload;

ISecretsManagerListSecretsResponse

List the secrets that are stored by Secrets Manager.

Returns

Response containing ListSecrets results.

ListSecretVersionIds

function ListSecretVersionIds( const ARequest: ISecretsManagerListSecretVersionIdsRequest): ISecretsManagerListSecretVersionIdsResponse;

ISecretsManagerListSecretVersionIdsRequest → ISecretsManagerListSecretVersionIdsResponse

List the version of a secret.

Parameters

Name	Description
ARequest	A ListSecretVersionIds request object.

Returns

Response containing ListSecretVersionIds results.

PutResourcePolicy

function PutResourcePolicy( const ARequest: ISecretsManagerPutResourcePolicyRequest): ISecretsManagerPutResourcePolicyResponse;

ISecretsManagerPutResourcePolicyRequest → ISecretsManagerPutResourcePolicyResponse

Attach a resource-based permission policy to a secret.

Parameters

Name	Description
ARequest	A PutResourcePolicy request object.

Returns

Response containing PutResourcePolicy results.

PutSecretValue

function PutSecretValue( const ARequest: ISecretsManagerPutSecretValueRequest): ISecretsManagerPutSecretValueResponse;

ISecretsManagerPutSecretValueRequest → ISecretsManagerPutSecretValueResponse

Create a new version with a new encrypted secret value and attaches it to the secret.

Parameters

Name	Description
ARequest	A PutSecretValue request object.

Returns

Response containing PutSecretValue results.

RemoveRegionsFromReplication

function RemoveRegionsFromReplication( const ARequest: ISecretsManagerRemoveRegionsFromReplicationRequest): ISecretsManagerRemoveRegionsFromReplicationResponse; overload;

ISecretsManagerRemoveRegionsFromReplicationRequest → ISecretsManagerRemoveRegionsFromReplicationResponse

Delete a replica of a secret that is replicated across regions.

Parameters

Name	Description
ARequest	A RemoveRegionsFromReplication request object.

Returns

Response containing RemoveRegionsFromReplication results.

---

function RemoveRegionsFromReplication( const ASecretId: string; const ARemoveReplicaRegions: array of string): ISecretsManagerRemoveRegionsFromReplicationResponse; overload;

ISecretsManagerRemoveRegionsFromReplicationResponse

Delete a replica of a secret that is replicated across regions.

Parameters

Name	Description
ASecretId	Specify the Amazon Resource Name (ARN) or name of the secret.
ARemoveReplicaRegions	Specify a list of regions to remove replicas from.

Returns

Response containing RemoveRegionsFromReplication results.

ReplicateSecretToRegions

function ReplicateSecretToRegions( const ARequest: ISecretsManagerReplicateSecretToRegionsRequest): ISecretsManagerReplicateSecretToRegionsResponse;

ISecretsManagerReplicateSecretToRegionsRequest → ISecretsManagerReplicateSecretToRegionsResponse

Replicate the secret to a new region.

Parameters

Name	Description
ARequest	A ReplicateSecretToRegions request object.

Returns

Response containing ReplicateSecretToRegions results.

RestoreSecret

function RestoreSecret( const ARequest: ISecretsManagerRestoreSecretRequest): ISecretsManagerRestoreSecretResponse; overload;

ISecretsManagerRestoreSecretRequest → ISecretsManagerRestoreSecretResponse

Cancel the scheduled deletion of a secret by removing the DeletedDate time stamp.

Parameters

Name	Description
ARequest	A RestoreSecret request object.

Returns

Response containing RestoreSecret results.

---

function RestoreSecret( const ASecretId: string): ISecretsManagerRestoreSecretResponse; overload;

ISecretsManagerRestoreSecretResponse

Cancel the scheduled deletion of a secret by removing the DeletedDate time stamp.

Parameters

Name	Description
ASecretId	Specify the Amazon Resource Name (ARN) or name of the secret to restore.

Returns

Response containing RestoreSecret results.

RotateSecret

function RotateSecret( const ARequest: ISecretsManagerRotateSecretRequest): ISecretsManagerRotateSecretResponse;

ISecretsManagerRotateSecretRequest → ISecretsManagerRotateSecretResponse

Configure and start the asynchronous process of rotating the secret.

Parameters

Name	Description
ARequest	A RotateSecret request object.

Returns

Response containing RotateResponse results.

StopReplicationToReplica

function StopReplicationToReplica( const ARequest: ISecretsManagerStopReplicationToReplicaRequest): ISecretsManagerStopReplicationToReplicaResponse; overload;

ISecretsManagerStopReplicationToReplicaRequest → ISecretsManagerStopReplicationToReplicaResponse

Remove the link between the replica secret and the primary secret and promote the replica to a primary secret in the replica region.

Parameters

Name	Description
ARequest	A StopReplicationToReplica request object.

Returns

Response containing StopReplicationToReplica results.

---

function StopReplicationToReplica( const ASecretId: string): ISecretsManagerStopReplicationToReplicaResponse; overload;

ISecretsManagerStopReplicationToReplicaResponse

Remove the link between the replica secret and the primary secret and promote the replica to a primary secret in the replica region.

Parameters

Name	Description
ASecretId	Specify the Amazon Resource Name (ARN) of the primary secret.

Returns

Response containing StopReplicationToReplica results.

TagResource

function TagResource( const ARequest: ISecretsManagerTagResourceRequest): ISecretsManagerTagResourceResponse;

ISecretsManagerTagResourceRequest → ISecretsManagerTagResourceResponse

Attach tags to a secret.

Parameters

Name	Description
ARequest	A TagResource request object.

Returns

Response containing TagResource results.

UntagResource

function UntagResource( const ARequest: ISecretsManagerUntagResourceRequest): ISecretsManagerUntagResourceResponse; overload;

ISecretsManagerUntagResourceRequest → ISecretsManagerUntagResourceResponse

Remove tags from a secret.

Parameters

Name	Description
ARequest	A UntagResource request object.

Returns

Response containing UntagResource results.

---

function UntagResource( const ASecretId: string; ATagKeys: array of string): ISecretsManagerUntagResourceResponse; overload;

ISecretsManagerUntagResourceResponse

Remove tags from a secret.

Parameters

Name	Description
ASecretId	Specify the Amazon Resource Name (ARN) or name of the secret.
ATagKeys	Specify a list of tag key names to remove from the secret.

Returns

Response containing UntagResource results.

UpdateSecret

function UpdateSecret( const ARequest: ISecretsManagerUpdateSecretRequest): ISecretsManagerUpdateSecretResponse;

ISecretsManagerUpdateSecretRequest → ISecretsManagerUpdateSecretResponse

Update the details of a secret, including metadata and the secret value.

Parameters

Name	Description
ARequest	A UpdateSecret request object.

Returns

Response containing UpdateSecretResults.

UpdateSecretVersionStage

function UpdateSecretVersionStage( const ARequest: ISecretsManagerUpdateSecretVersionStageRequest): ISecretsManagerUpdateSecretVersionStageResponse;

ISecretsManagerUpdateSecretVersionStageRequest → ISecretsManagerUpdateSecretVersionStageResponse

Update the staging labels attached to a version of a secret.

Parameters

Name	Description
ARequest	A UpdateSecretVersionStage request object.

Returns

Response containing UpdateSecretVersionStage results.

ValidateResourcePolicy

function ValidateResourcePolicy( const ARequest: ISecretsManagerValidateResourcePolicyRequest): ISecretsManagerValidateResourcePolicyResponse; overload;

ISecretsManagerValidateResourcePolicyRequest → ISecretsManagerValidateResourcePolicyResponse

Validate that a resource policy does not grant a wide range of principals access to your secret.

Parameters

Name	Description
ARequest	A ValidateResourcePolicy request object.

Returns

Response containing ValidateResourcePolicy results.

---

function ValidateResourcePolicy( const AResourcePolicy: string): ISecretsManagerValidateResourcePolicyResponse; overload;

ISecretsManagerValidateResourcePolicyResponse

Validate that a resource policy does not grant a wide range of principals access to your secret.

Parameters

Name	Description
AResourcePolicy	Specify a JSON-formatted string that contains an AWS resource-based policy.

Returns

Response containing ValidateResourcePolicy results.