Indicates whether the VPC is the default VPC.
", "VpcClassicLink$ClassicLinkEnabled": "Indicates whether the VPC is enabled for ClassicLink.
", "VpcEndpoint$PrivateDnsEnabled": "(Interface endpoint) Indicates whether the VPC is associated with a private hosted zone.
", - "VpcEndpoint$RequesterManaged": "Indicates whether the VPC endpoint is being managed by its service.
", + "VpcEndpoint$RequesterManaged": "Indicates whether the endpoint is being managed by its service.
", "VpcPeeringConnectionOptionsDescription$AllowDnsResolutionFromRemoteVpc": "Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.
", "VpcPeeringConnectionOptionsDescription$AllowEgressFromLocalClassicLinkToRemoteVpc": "Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection.
", "VpcPeeringConnectionOptionsDescription$AllowEgressFromLocalVpcToRemoteClassicLink": "Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection.
", @@ -7145,6 +7145,26 @@ "ServiceDetail$PrivateDnsNameVerificationState": "The verification state of the VPC endpoint service.
Consumers of the endpoint service cannot use the private name when the state is not verified.
Describes the DNS options for an endpoint.
", + "refs": { + "VpcEndpoint$DnsOptions": "The DNS options for the endpoint.
" + } + }, + "DnsOptionsSpecification": { + "base": "Describes the DNS options for an endpoint.
", + "refs": { + "CreateVpcEndpointRequest$DnsOptions": "The DNS options for the endpoint.
", + "ModifyVpcEndpointRequest$DnsOptions": "The DNS options for the endpoint.
" + } + }, + "DnsRecordIpType": { + "base": null, + "refs": { + "DnsOptions$DnsRecordIpType": "The DNS records created for the endpoint.
", + "DnsOptionsSpecification$DnsRecordIpType": "The DNS records created for the endpoint.
" + } + }, "DnsServersOptionsModifyStructure": { "base": "Information about the DNS server to be used.
", "refs": { @@ -8010,11 +8030,11 @@ "DescribeVolumesRequest$Filters": "The filters.
attachment.attach-time - The time stamp when the attachment initiated.
attachment.delete-on-termination - Whether the volume is deleted on instance termination.
attachment.device - The device name specified in the block device mapping (for example, /dev/sda1).
attachment.instance-id - The ID of the instance the volume is attached to.
attachment.status - The attachment state (attaching | attached | detaching).
availability-zone - The Availability Zone in which the volume was created.
create-time - The time stamp when the volume was created.
encrypted - Indicates whether the volume is encrypted (true | false)
multi-attach-enabled - Indicates whether the volume is enabled for Multi-Attach (true | false)
fast-restored - Indicates whether the volume was created from a snapshot that is enabled for fast snapshot restore (true | false).
size - The size of the volume, in GiB.
snapshot-id - The snapshot from which the volume was created.
status - The state of the volume (creating | available | in-use | deleting | deleted | error).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
volume-id - The volume ID.
volume-type - The Amazon EBS volume type (gp2 | gp3 | io1 | io2 | st1 | sc1| standard)
One or more filters.
is-classic-link-enabled - Whether the VPC is enabled for ClassicLink (true | false).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more filters.
connection-notification-arn - The ARN of the SNS topic for the notification.
connection-notification-id - The ID of the notification.
connection-notification-state - The state of the notification (Enabled | Disabled).
connection-notification-type - The type of notification (Topic).
service-id - The ID of the endpoint service.
vpc-endpoint-id - The ID of the VPC endpoint.
One or more filters.
service-id - The ID of the service.
vpc-endpoint-owner - The ID of the Amazon Web Services account ID that owns the endpoint.
vpc-endpoint-state - The state of the endpoint (pendingAcceptance | pending | available | deleting | deleted | rejected | failed).
vpc-endpoint-id - The ID of the endpoint.
One or more filters.
service-name - The name of the service.
service-id - The ID of the service.
service-state - The state of the service (Pending | Available | Deleting | Deleted | Failed).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more filters.
ip-address-type - The IP address type (ipv4 | ipv6).
service-id - The ID of the service.
vpc-endpoint-owner - The ID of the Amazon Web Services account ID that owns the endpoint.
vpc-endpoint-state - The state of the endpoint (pendingAcceptance | pending | available | deleting | deleted | rejected | failed).
vpc-endpoint-id - The ID of the endpoint.
One or more filters.
service-name - The name of the service.
service-id - The ID of the service.
service-state - The state of the service (Pending | Available | Deleting | Deleted | Failed).
supported-ip-address-types - The IP address type (ipv4 | ipv6).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more filters.
principal - The ARN of the principal.
principal-type - The principal type (All | Service | OrganizationUnit | Account | User | Role).
One or more filters.
service-name - The name of the service.
service-type - The type of service (Interface | Gateway).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more filters.
service-name - The name of the service.
vpc-id - The ID of the VPC in which the endpoint resides.
vpc-endpoint-id - The ID of the endpoint.
vpc-endpoint-state - The state of the endpoint (pendingAcceptance | pending | available | deleting | deleted | rejected | failed).
vpc-endpoint-type - The type of VPC endpoint (Interface | Gateway | GatewayLoadBalancer).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more filters.
service-name - The name of the service.
service-type - The type of service (Interface | Gateway).
supported-ip-address-types - The IP address type (ipv4 | ipv6).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more filters.
ip-address-type - The IP address type (ipv4 | ipv6).
service-name - The name of the service.
vpc-id - The ID of the VPC in which the endpoint resides.
vpc-endpoint-id - The ID of the endpoint.
vpc-endpoint-state - The state of the endpoint (pendingAcceptance | pending | available | deleting | deleted | rejected | failed).
vpc-endpoint-type - The type of VPC endpoint (Interface | Gateway | GatewayLoadBalancer).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more filters.
accepter-vpc-info.cidr-block - The IPv4 CIDR block of the accepter VPC.
accepter-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the accepter VPC.
accepter-vpc-info.vpc-id - The ID of the accepter VPC.
expiration-time - The expiration date and time for the VPC peering connection.
requester-vpc-info.cidr-block - The IPv4 CIDR block of the requester's VPC.
requester-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the requester VPC.
requester-vpc-info.vpc-id - The ID of the requester VPC.
status-code - The status of the VPC peering connection (pending-acceptance | failed | expired | provisioning | active | deleting | deleted | rejected).
status-message - A message that provides more information about the status of the VPC peering connection, if applicable.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-peering-connection-id - The ID of the VPC peering connection.
One or more filters.
cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, /28).
cidr-block-association.cidr-block - An IPv4 CIDR block associated with the VPC.
cidr-block-association.association-id - The association ID for an IPv4 CIDR block associated with the VPC.
cidr-block-association.state - The state of an IPv4 CIDR block associated with the VPC.
dhcp-options-id - The ID of a set of DHCP options.
ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the VPC.
ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.
ipv6-cidr-block-association.association-id - The association ID for an IPv6 CIDR block associated with the VPC.
ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the VPC.
is-default - Indicates whether the VPC is the default VPC.
owner-id - The ID of the Amazon Web Services account that owns the VPC.
state - The state of the VPC (pending | available).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC.
One or more filters.
customer-gateway-configuration - The configuration information for the customer gateway.
customer-gateway-id - The ID of a customer gateway associated with the VPN connection.
state - The state of the VPN connection (pending | available | deleting | deleted).
option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).
route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.
bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
type - The type of VPN connection. Currently the only supported type is ipsec.1.
vpn-connection-id - The ID of the VPN connection.
vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.
transit-gateway-id - The ID of a transit gateway associated with the VPN connection.
The IPv4 addresses, in CIDR notation.
" } }, + "IpAddressType": { + "base": null, + "refs": { + "CreateVpcEndpointRequest$IpAddressType": "The IP address type for the endpoint.
", + "ModifyVpcEndpointRequest$IpAddressType": "The IP address type for the endpoint.
", + "VpcEndpoint$IpAddressType": "The IP address type for the endpoint.
", + "VpcEndpointConnection$IpAddressType": "The IP address type for the endpoint.
" + } + }, "IpPermission": { "base": "Describes a set of permissions for a security group rule.
", "refs": { @@ -11307,7 +11336,7 @@ "LastError": { "base": "The last error that occurred for a VPC endpoint.
", "refs": { - "VpcEndpoint$LastError": "The last error that occurred for VPC endpoint.
" + "VpcEndpoint$LastError": "The last error that occurred for endpoint.
" } }, "LaunchPermission": { @@ -12352,7 +12381,7 @@ "StoreImageTaskResult$TaskStartTime": "The time the task started.
", "VolumeStatusEvent$NotAfter": "The latest end time of the event.
", "VolumeStatusEvent$NotBefore": "The earliest start time of the event.
", - "VpcEndpoint$CreationTimestamp": "The date and time that the VPC endpoint was created.
", + "VpcEndpoint$CreationTimestamp": "The date and time that the endpoint was created.
", "VpcEndpointConnection$CreationTimestamp": "The date and time that the VPC endpoint was created.
" } }, @@ -15820,6 +15849,12 @@ "DescribeVpcEndpointServiceConfigurationsResult$ServiceConfigurations": "Information about one or more services.
" } }, + "ServiceConnectivityType": { + "base": null, + "refs": { + "SupportedIpAddressTypes$member": null + } + }, "ServiceDetail": { "base": "Describes a VPC endpoint service.
", "refs": { @@ -16270,7 +16305,7 @@ "State": { "base": null, "refs": { - "VpcEndpoint$State": "The state of the VPC endpoint.
", + "VpcEndpoint$State": "The state of the endpoint.
", "VpcEndpointConnection$VpcEndpointState": "The state of the VPC endpoint.
" } }, @@ -18134,11 +18169,11 @@ "VpcCidrBlockAssociation$CidrBlock": "The IPv4 CIDR block.
", "VpcCidrBlockState$StatusMessage": "A message about the status of the CIDR block, if applicable.
", "VpcClassicLink$VpcId": "The ID of the VPC.
", - "VpcEndpoint$VpcEndpointId": "The ID of the VPC endpoint.
", + "VpcEndpoint$VpcEndpointId": "The ID of the endpoint.
", "VpcEndpoint$VpcId": "The ID of the VPC to which the endpoint is associated.
", "VpcEndpoint$ServiceName": "The name of the service to which the endpoint is associated.
", "VpcEndpoint$PolicyDocument": "The policy document associated with the endpoint, if applicable.
", - "VpcEndpoint$OwnerId": "The ID of the Amazon Web Services account that owns the VPC endpoint.
", + "VpcEndpoint$OwnerId": "The ID of the Amazon Web Services account that owns the endpoint.
", "VpcEndpointConnection$ServiceId": "The ID of the service to which the endpoint is connected.
", "VpcEndpointConnection$VpcEndpointId": "The ID of the VPC endpoint.
", "VpcEndpointConnection$VpcEndpointOwner": "The ID of the Amazon Web Services account that owns the VPC endpoint.
", @@ -18358,6 +18393,13 @@ "InstanceStatusSummary$Status": "The status.
" } }, + "SupportedIpAddressTypes": { + "base": null, + "refs": { + "ServiceConfiguration$SupportedIpAddressTypes": "The supported IP address types.
", + "ServiceDetail$SupportedIpAddressTypes": "The supported IP address types.
" + } + }, "Tag": { "base": "Describes a tag.
", "refs": { @@ -18473,7 +18515,7 @@ "Volume$Tags": "Any tags assigned to the volume.
", "Vpc$Tags": "Any tags assigned to the VPC.
", "VpcClassicLink$Tags": "Any tags assigned to the VPC.
", - "VpcEndpoint$Tags": "Any tags assigned to the VPC endpoint.
", + "VpcEndpoint$Tags": "Any tags assigned to the endpoint.
", "VpcPeeringConnection$Tags": "Any tags assigned to the resource.
", "VpnConnection$Tags": "Any tags assigned to the VPN connection.
", "VpnGateway$Tags": "Any tags assigned to the virtual private gateway.
" @@ -19861,6 +19903,7 @@ "CreateVpcEndpointConnectionNotificationRequest$ConnectionEvents": "One or more endpoint events for which to receive notifications. Valid values are Accept, Connect, Delete, and Reject.
The Amazon Resource Names (ARNs) of one or more Network Load Balancers for your service.
", "CreateVpcEndpointServiceConfigurationRequest$GatewayLoadBalancerArns": "The Amazon Resource Names (ARNs) of one or more Gateway Load Balancers.
", + "CreateVpcEndpointServiceConfigurationRequest$SupportedIpAddressTypes": "The supported IP address types. The possible values are ipv4 and ipv6.
The IDs of the target network associations.
", "DescribeIpamPoolsRequest$IpamPoolIds": "The IDs of the IPAM pools you would like information on.
", "DescribeIpamScopesRequest$IpamScopeIds": "The IDs of the scopes you want information on.
", @@ -19878,6 +19921,8 @@ "ModifyVpcEndpointServiceConfigurationRequest$RemoveNetworkLoadBalancerArns": "The Amazon Resource Names (ARNs) of Network Load Balancers to remove from your service configuration.
", "ModifyVpcEndpointServiceConfigurationRequest$AddGatewayLoadBalancerArns": "The Amazon Resource Names (ARNs) of Gateway Load Balancers to add to your service configuration.
", "ModifyVpcEndpointServiceConfigurationRequest$RemoveGatewayLoadBalancerArns": "The Amazon Resource Names (ARNs) of Gateway Load Balancers to remove from your service configuration.
", + "ModifyVpcEndpointServiceConfigurationRequest$AddSupportedIpAddressTypes": "The IP address types to add to your service configuration.
", + "ModifyVpcEndpointServiceConfigurationRequest$RemoveSupportedIpAddressTypes": "The IP address types to remove from your service configuration.
", "ModifyVpcEndpointServicePermissionsRequest$AddAllowedPrincipals": "The Amazon Resource Names (ARN) of one or more principals. Permissions are granted to the principals in this list. To grant permissions to all principals, specify an asterisk (*).
", "ModifyVpcEndpointServicePermissionsRequest$RemoveAllowedPrincipals": "The Amazon Resource Names (ARN) of one or more principals. Permissions are revoked for principals in this list.
", "NewDhcpConfiguration$Values": null, @@ -19915,7 +19960,7 @@ "TransitGatewayOptions$TransitGatewayCidrBlocks": "The transit gateway CIDR blocks.
", "TransitGatewayVpcAttachment$SubnetIds": "The IDs of the subnets.
", "VpcEndpoint$RouteTableIds": "(Gateway endpoint) One or more route tables associated with the endpoint.
", - "VpcEndpoint$SubnetIds": "(Interface endpoint) One or more subnets in which the endpoint is located.
", + "VpcEndpoint$SubnetIds": "(Interface endpoint) The subnets for the endpoint.
", "VpcEndpoint$NetworkInterfaceIds": "(Interface endpoint) One or more network interfaces for the endpoint.
", "VpcEndpointConnection$NetworkLoadBalancerArns": "The Amazon Resource Names (ARNs) of the network load balancers for the service.
", "VpcEndpointConnection$GatewayLoadBalancerArns": "The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.
" diff --git a/models/apis/secretsmanager/2017-10-17/docs-2.json b/models/apis/secretsmanager/2017-10-17/docs-2.json index 73e3067b1b5..116ca8bd5ab 100644 --- a/models/apis/secretsmanager/2017-10-17/docs-2.json +++ b/models/apis/secretsmanager/2017-10-17/docs-2.json @@ -2,16 +2,16 @@ "version": "2.0", "service": "Amazon Web Services Secrets Manager provides a service to enable 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 Amazon Web Services Secrets Manager User Guide.
API Version
This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.
Support and Feedback for Amazon Web Services Secrets Manager
We welcome your feedback. Send your comments to awssecretsmanager-feedback@amazon.com, or post your feedback and questions in the Amazon Web Services Secrets Manager Discussion Forum. For more information about the Amazon Web Services Discussion Forums, see Forums Help.
Logging API Requests
Amazon Web Services Secrets Manager supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information that's collected by Amazon Web Services CloudTrail, you can determine the requests successfully made to Secrets Manager, who made the request, when it was made, and so on. For more about Amazon Web Services Secrets Manager and support for Amazon Web Services CloudTrail, see Logging Amazon Web Services Secrets Manager Events with Amazon Web Services CloudTrail in the Amazon Web Services Secrets Manager User Guide. To learn more about CloudTrail, including enabling it and find your log files, see the Amazon Web Services CloudTrail User Guide.
", "operations": { - "CancelRotateSecret": "Turns off automatic rotation, and if a rotation is currently in progress, cancels the rotation.
To turn on automatic rotation again, call RotateSecret.
If you cancel a rotation in progress, it can leave the VersionStage labels in an unexpected state. Depending on the step of the rotation in progress, you might need to remove the staging label AWSPENDING from the partially created version, specified by the VersionId response value. We recommend you also evaluate the partially rotated new version to see if it should be deleted. You can delete a version by removing all staging labels from it.
Required permissions: secretsmanager:CancelRotateSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Turns off automatic rotation, and if a rotation is currently in progress, cancels the rotation.
If you cancel a rotation in progress, it can leave the VersionStage labels in an unexpected state. You might need to remove the staging label AWSPENDING from the partially created version. You also need to determine whether to roll back to the previous version of the secret by moving the staging label AWSCURRENT to the version that has AWSPENDING. To determine which version has a specific staging label, call ListSecretVersionIds. Then use UpdateSecretVersionStage to change staging labels. For more information, see How rotation works.
To turn on automatic rotation again, call RotateSecret.
Required permissions: secretsmanager:CancelRotateSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Creates a new secret. A secret can be a password, a set of credentials such as a user name and password, an OAuth token, or other secret information that you store in an encrypted form in Secrets Manager. The secret also includes the connection information to access a database or other service, which Secrets Manager doesn't encrypt. A secret in Secrets Manager consists of both the protected secret data and the important information needed to manage the secret.
For information about creating a secret in the console, see Create a secret.
To create a secret, you can provide the secret value to be encrypted in either the SecretString parameter or the SecretBinary parameter, but not both. If you include SecretString or SecretBinary then Secrets Manager creates an initial secret version and automatically attaches the staging label AWSCURRENT to it.
For database credentials you want to rotate, for Secrets Manager to be able to rotate the secret, you must make sure the JSON you store in the SecretString matches the JSON structure of a database secret.
If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key aws/secretsmanager. If this key doesn't already exist in your account, then Secrets Manager creates it for you automatically. All users and roles in the Amazon Web Services account automatically have access to use aws/secretsmanager. Creating aws/secretsmanager can result in a one-time significant delay in returning the result.
If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't use aws/secretsmanager to encrypt the secret, and you must create and use a customer managed KMS key.
Required permissions: secretsmanager:CreateSecret. If you include tags in the secret, you also need secretsmanager:TagResource. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
To encrypt the secret with a KMS key other than aws/secretsmanager, you need kms:GenerateDataKey and kms:Decrypt permission to the key.
Deletes the resource-based permission policy attached to the secret. To attach a policy to a secret, use PutResourcePolicy.
Required permissions: secretsmanager:DeleteResourcePolicy. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Deletes a secret and all of its versions. You can specify a recovery window during which you can restore the secret. The minimum recovery window is 7 days. The default recovery window is 30 days. Secrets Manager attaches a DeletionDate stamp to the secret that specifies the end of the recovery window. At the end of the recovery window, Secrets Manager deletes the secret permanently.
For information about deleting a secret in the console, see https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_delete-secret.html.
Secrets Manager performs the permanent secret deletion at the end of the waiting period as a background task with low priority. There is no guarantee of a specific time after the recovery window for the permanent delete to occur.
At any time before recovery window ends, you can use RestoreSecret to remove the DeletionDate and cancel the deletion of the secret.
In a secret scheduled for deletion, you cannot access the encrypted secret value. To access that information, first cancel the deletion with RestoreSecret and then retrieve the information.
Required permissions: secretsmanager:DeleteSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Deletes a secret and all of its versions. You can specify a recovery window during which you can restore the secret. The minimum recovery window is 7 days. The default recovery window is 30 days. Secrets Manager attaches a DeletionDate stamp to the secret that specifies the end of the recovery window. At the end of the recovery window, Secrets Manager deletes the secret permanently.
You can't delete a primary secret that is replicated to other Regions. You must first delete the replicas using RemoveRegionsFromReplication, and then delete the primary secret. When you delete a replica, it is deleted immediately.
You can't directly delete a version of a secret. Instead, you remove all staging labels from the version using UpdateSecretVersionStage. This marks the version as deprecated, and then Secrets Manager can automatically delete the version in the background.
To determine whether an application still uses a secret, you can create an Amazon CloudWatch alarm to alert you to any attempts to access a secret during the recovery window. For more information, see Monitor secrets scheduled for deletion.
Secrets Manager performs the permanent secret deletion at the end of the waiting period as a background task with low priority. There is no guarantee of a specific time after the recovery window for the permanent delete to occur.
At any time before recovery window ends, you can use RestoreSecret to remove the DeletionDate and cancel the deletion of the secret.
When a secret is scheduled for deletion, you cannot retrieve the secret value. You must first cancel the deletion with RestoreSecret and then you can retrieve the secret.
Required permissions: secretsmanager:DeleteSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Retrieves the details of a secret. It does not include the encrypted secret value. Secrets Manager only returns fields that have a value in the response.
Required permissions: secretsmanager:DescribeSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Generates a random password. We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.
Required permissions: secretsmanager:GetRandomPassword. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Retrieves the JSON text of the resource-based policy document attached to the secret. For more information about permissions policies attached to a secret, see Permissions policies attached to a secret.
Required permissions: secretsmanager:GetResourcePolicy. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Retrieves the contents of the encrypted fields SecretString or SecretBinary from the specified version of a secret, whichever contains content.
We recommend that you cache your secret values by using client-side caching. Caching secrets improves speed and reduces your costs. For more information, see Cache secrets for your applications.
Required permissions: secretsmanager:GetSecretValue. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key aws/secretsmanager, then you also need kms:Decrypt permissions for that key. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Lists the versions for a secret.
To list the secrets in the account, use ListSecrets.
To get the secret value from SecretString or SecretBinary, call GetSecretValue.
Required permissions: secretsmanager:ListSecretVersionIds. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account, not including secrets that are marked for deletion. To see secrets marked for deletion, use the Secrets Manager console.
To list the versions of a secret, use ListSecretVersionIds.
To get the secret value from SecretString or SecretBinary, call GetSecretValue.
For information about finding secrets in the console, see Enhanced search capabilities for secrets in Secrets Manager.
Required permissions: secretsmanager:ListSecrets. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Lists the versions of a secret. Secrets Manager uses staging labels to indicate the different versions of a secret. For more information, see Secrets Manager concepts: Versions.
To list the secrets in the account, use ListSecrets.
Required permissions: secretsmanager:ListSecretVersionIds. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account, not including secrets that are marked for deletion. To see secrets marked for deletion, use the Secrets Manager console.
To list the versions of a secret, use ListSecretVersionIds.
To get the secret value from SecretString or SecretBinary, call GetSecretValue.
For information about finding secrets in the console, see Find secrets in Secrets Manager.
Required permissions: secretsmanager:ListSecrets. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Attaches a resource-based permission policy to a secret. A resource-based policy is optional. For more information, see Authentication and access control for Secrets Manager
For information about attaching a policy in the console, see Attach a permissions policy to a secret.
Required permissions: secretsmanager:PutResourcePolicy. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Creates a new version with a new encrypted secret value and attaches it to the secret. The version can contain a new SecretString value or a new SecretBinary value.
We recommend you avoid calling PutSecretValue at a sustained rate of more than once every 10 minutes. When you update the secret value, Secrets Manager creates a new version of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not remove versions created less than 24 hours ago. If you call PutSecretValue more than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach the quota for secret versions.
You can specify the staging labels to attach to the new version in VersionStages. If you don't include VersionStages, then Secrets Manager automatically moves the staging label AWSCURRENT to this version. If this operation creates the first version for the secret, then Secrets Manager automatically attaches the staging label AWSCURRENT to it .
If this operation moves the staging label AWSCURRENT from another version to this version, then Secrets Manager also automatically moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from.
This operation is idempotent. If a version with a VersionId with the same value as the ClientRequestToken parameter already exists, and you specify the same secret data, the operation succeeds but does nothing. However, if the secret data is different, then the operation fails because you can't modify an existing version; you can only create new ones.
Required permissions: secretsmanager:PutSecretValue. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify.
Required permissions: secretsmanager:RemoveRegionsFromReplication. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.