delete_resource_policy¶
Operation¶
delete_resource_policy
¶
delete_resource_policy(request: DeleteResourcePolicyInput | DeleteResourcePolicyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteResourcePolicyInputDict]) -> DeleteResourcePolicyOutput
Deletes the resource-based permission policy attached to the secret. To attach a policy to a secret, use PutResourcePolicy.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:DeleteResourcePolicy. For
more information, see IAM policy actions for Secrets
Manager
and Authentication and access control in Secrets
Manager.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DeleteResourcePolicyInput | DeleteResourcePolicyInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[DeleteResourcePolicyInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeleteResourcePolicyOutput
|
An instance of |
delete_resource_policy
async
¶
delete_resource_policy(request: DeleteResourcePolicyInput | DeleteResourcePolicyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteResourcePolicyInputDict]) -> DeleteResourcePolicyOutput
Deletes the resource-based permission policy attached to the secret. To attach a policy to a secret, use PutResourcePolicy.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:DeleteResourcePolicy. For
more information, see IAM policy actions for Secrets
Manager
and Authentication and access control in Secrets
Manager.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DeleteResourcePolicyInput | DeleteResourcePolicyInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[DeleteResourcePolicyInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeleteResourcePolicyOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
DeleteResourcePolicyInputDict
¶
Bases: TypedDict
Dictionary form of DeleteResourcePolicyInput.
Attributes¶
policy_name
instance-attribute
¶
policy_name: str | None
The name of the resource policy to delete. If you don't specify this
field, Secrets Manager uses default. You can only delete the default
policy; if you specify any other name, the operation returns an
InvalidParameterException.
secret_id
instance-attribute
¶
The ARN or name of the secret to delete the attached resource-based policy for.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
DeleteResourcePolicyInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DeleteResourcePolicyInput structure.
Attributes¶
policy_name
class-attribute
instance-attribute
¶
policy_name: str | None = ...
The name of the resource policy to delete. If you don't specify this
field, Secrets Manager uses default. You can only delete the default
policy; if you specify any other name, the operation returns an
InvalidParameterException.
secret_id
class-attribute
instance-attribute
¶
secret_id: str | None = ...
The ARN or name of the secret to delete the attached resource-based policy for.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
Output¶
DeleteResourcePolicyOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DeleteResourcePolicyOutput structure.
Attributes¶
arn
class-attribute
instance-attribute
¶
arn: str | None = ...
The ARN of the secret that the resource-based policy was deleted for.
name
class-attribute
instance-attribute
¶
name: str | None = ...
The name of the secret that the resource-based policy was deleted for.
policy_name
class-attribute
instance-attribute
¶
policy_name: str | None = ...
The name of the deleted resource policy. If you didn't specify
PolicyName in the request, this is default.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.