❤
npm
Sign UpSign In

@datafire/amazonaws_secretsmanager

5.0.0 • Public • Published

@datafire/amazonaws_secretsmanager

Client library for AWS Secrets Manager

Installation and Usage

npm install --save @datafire/amazonaws_secretsmanager
let amazonaws_secretsmanager = require('@datafire/amazonaws_secretsmanager').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_secretsmanager.CancelRotateSecret({
  "SecretId": ""
}).then(data => {
  console.log(data);
});

Description

AWS Secrets Manager API Reference

AWS Secrets Manager is a web service that enables you to store, manage, and retrieve, secrets.

This guide provides descriptions of the Secrets Manager API. For more information about using this service, see the AWS Secrets Manager User Guide.

API Version

This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.

As an alternative to using the API directly, you can use one of the AWS SDKs, which consist of libraries and sample code for various programming languages and platforms (such as Java, Ruby, .NET, iOS, and Android). The SDKs provide a convenient way to create programmatic access to AWS Secrets Manager. For example, the SDKs take care of cryptographically signing requests, managing errors, and retrying requests automatically. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.

We recommend that you use the AWS SDKs to make programmatic API calls to Secrets Manager. However, you also can use the Secrets Manager HTTP Query API to make direct calls to the Secrets Manager web service. To learn more about the Secrets Manager HTTP Query API, see Making Query Requests in the AWS Secrets Manager User Guide.

Secrets Manager supports GET and POST requests for all actions. That is, the API doesn't require you to use GET for some actions and POST for others. However, GET requests are subject to the limitation size of a URL. Therefore, for operations that require larger sizes, use a POST request.

Support and Feedback for AWS Secrets Manager

We welcome your feedback. Send your comments to awssecretsmanager-feedback@amazon.com, or post your feedback and questions in the AWS Secrets Manager Discussion Forum. For more information about the AWS Discussion Forums, see Forums Help.

How examples are presented

The JSON that AWS Secrets Manager expects as your request parameters and that the service returns as a response to HTTP query requests are single, long strings without line breaks or white space formatting. The JSON shown in the examples is formatted with both line breaks and white space to improve readability. When example input parameters would also result in long strings that extend beyond the screen, we insert line breaks to enhance readability. You should always submit the input as a single JSON text string.

Logging API Requests

AWS Secrets Manager supports AWS CloudTrail, a service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information that's collected by AWS CloudTrail, you can determine which requests were successfully made to Secrets Manager, who made the request, when it was made, and so on. For more about AWS Secrets Manager and its support for AWS CloudTrail, see Logging AWS Secrets Manager Events with AWS CloudTrail in the AWS Secrets Manager User Guide. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide.

Actions

CancelRotateSecret

amazonaws_secretsmanager.CancelRotateSecret({
  "SecretId": ""
}, context)

Input

Output

CreateSecret

amazonaws_secretsmanager.CreateSecret({
  "Name": ""
}, context)

Input

Output

DeleteSecret

amazonaws_secretsmanager.DeleteSecret({
  "SecretId": ""
}, context)

Input

Output

DescribeSecret

amazonaws_secretsmanager.DescribeSecret({
  "SecretId": ""
}, context)

Input

Output

GetRandomPassword

amazonaws_secretsmanager.GetRandomPassword({}, context)

Input

Output

GetSecretValue

amazonaws_secretsmanager.GetSecretValue({
  "SecretId": ""
}, context)

Input

Output

ListSecretVersionIds

amazonaws_secretsmanager.ListSecretVersionIds({
  "SecretId": ""
}, context)

Input

Output

ListSecrets

amazonaws_secretsmanager.ListSecrets({}, context)

Input

Output

PutSecretValue

amazonaws_secretsmanager.PutSecretValue({
  "SecretId": ""
}, context)

Input

Output

RestoreSecret

amazonaws_secretsmanager.RestoreSecret({
  "SecretId": ""
}, context)

Input

Output

RotateSecret

amazonaws_secretsmanager.RotateSecret({
  "SecretId": ""
}, context)

Input

Output

TagResource

amazonaws_secretsmanager.TagResource({
  "SecretId": "",
  "Tags": []
}, context)

Input

Output

Output schema unknown

UntagResource

amazonaws_secretsmanager.UntagResource({
  "SecretId": "",
  "TagKeys": []
}, context)

Input

Output

Output schema unknown

UpdateSecret

amazonaws_secretsmanager.UpdateSecret({
  "SecretId": ""
}, context)

Input

Output

UpdateSecretVersionStage

amazonaws_secretsmanager.UpdateSecretVersionStage({
  "SecretId": "",
  "VersionStage": ""
}, context)

Input

Output

Definitions

AutomaticallyRotateAfterDaysType

  • AutomaticallyRotateAfterDaysType integer

BooleanType

  • BooleanType boolean

CancelRotateSecretRequest

  • CancelRotateSecretRequest object

CancelRotateSecretResponse

ClientRequestTokenType

  • ClientRequestTokenType string

CreateSecretRequest

CreateSecretResponse

CreatedDateType

  • CreatedDateType string

DecryptionFailure

  • DecryptionFailure object: Secrets Manager can't decrypt the protected secret text using the provided KMS key.

DeleteSecretRequest

DeleteSecretResponse

DeletedDateType

  • DeletedDateType string

DeletionDateType

  • DeletionDateType string

DescribeSecretRequest

  • DescribeSecretRequest object

DescribeSecretResponse

DescriptionType

  • DescriptionType string

EncryptionFailure

ErrorMessage

  • ErrorMessage string

ExcludeCharactersType

  • ExcludeCharactersType string

ExcludeLowercaseType

  • ExcludeLowercaseType boolean

ExcludeNumbersType

  • ExcludeNumbersType boolean

ExcludePunctuationType

  • ExcludePunctuationType boolean

ExcludeUppercaseType

  • ExcludeUppercaseType boolean

GetRandomPasswordRequest

GetRandomPasswordResponse

GetSecretValueRequest

GetSecretValueResponse

IncludeSpaceType

  • IncludeSpaceType boolean

InternalServiceError

  • InternalServiceError object: An error occurred on the server side.

InvalidNextTokenException

  • InvalidNextTokenException object: You provided an invalid NextToken value.

InvalidParameterException

  • InvalidParameterException object: You provided an invalid value for a parameter.

InvalidRequestException

  • InvalidRequestException object: You provided a parameter value that is not valid for the current state of the resource. For example, if you try to enable rotation on a secret, you must already have a Lambda function ARN configured or included as a parameter in this call.

KmsKeyIdType

  • KmsKeyIdType string

LastAccessedDateType

  • LastAccessedDateType string

LastChangedDateType

  • LastChangedDateType string

LastRotatedDateType

  • LastRotatedDateType string

LimitExceededException

  • LimitExceededException object: The request failed because it would exceed one of the Secrets Manager internal limits.

ListSecretVersionIdsRequest

ListSecretVersionIdsResponse

ListSecretsRequest

ListSecretsResponse

MalformedPolicyDocumentException

  • MalformedPolicyDocumentException object: The policy document that you provided isn't valid.

MaxResultsType

  • MaxResultsType integer

NameType

  • NameType string

NextTokenType

  • NextTokenType string

PasswordLengthType

  • PasswordLengthType integer

PutSecretValueRequest

PutSecretValueResponse

RandomPasswordType

  • RandomPasswordType string

RecoveryWindowInDaysType

  • RecoveryWindowInDaysType integer

RequireEachIncludedTypeType

  • RequireEachIncludedTypeType boolean

ResourceExistsException

  • ResourceExistsException object: A resource with the ID you requested already exists.

ResourceNotFoundException

  • ResourceNotFoundException object: We can't find the resource that you asked for.

RestoreSecretRequest

  • RestoreSecretRequest object

RestoreSecretResponse

RotateSecretRequest

RotateSecretResponse

RotationEnabledType

  • RotationEnabledType boolean

RotationLambdaARNType

  • RotationLambdaARNType string

RotationRulesType

SecretARNType

  • SecretARNType string

SecretBinaryType

  • SecretBinaryType string

SecretIdType

  • SecretIdType string

SecretListEntry

SecretListType

SecretNameType

  • SecretNameType string

SecretStringType

  • SecretStringType string

SecretVersionIdType

  • SecretVersionIdType string

SecretVersionStageType

  • SecretVersionStageType string

SecretVersionStagesType

SecretVersionsListEntry

SecretVersionsListType

SecretVersionsToStagesMapType

Tag

TagKeyListType

TagKeyType

  • TagKeyType string

TagListType

  • TagListType array

TagResourceRequest

TagValueType

  • TagValueType string

UntagResourceRequest

UpdateSecretRequest

UpdateSecretResponse

UpdateSecretVersionStageRequest

UpdateSecretVersionStageResponse

Readme

Keywords

none

Package Sidebar

Install

npm i @datafire/amazonaws_secretsmanager

Repository

github.com/DataFire/integrations

Homepage

github.com/DataFire/integrations#readme

Weekly Downloads

1

Version

5.0.0

License

MIT

Unpacked Size

163 kB

Total Files

4

Last publish

Collaborators

  • datafire
Try on RunKit
Report malware