get_resource_policy¶
Operation¶
async
¶
get_resource_policy(input: GetResourcePolicyInput, plugins: list[Plugin] | None = None) -> GetResourcePolicyOutput
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.
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:GetResourcePolicy. For more
information, see IAM policy actions for Secrets
Manager
and Authentication and access control in Secrets
Manager.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GetResourcePolicyInput
|
An instance of |
required |
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
|
Returns:
| Type | Description |
|---|---|
GetResourcePolicyOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for GetResourcePolicyInput structure.
Attributes¶
class-attribute
instance-attribute
¶
secret_id: str | None = None
The ARN or name of the secret to retrieve 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¶
dataclass
¶
Dataclass for GetResourcePolicyOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
arn: str | None = None
The ARN of the secret that the resource-based policy was retrieved for.
class-attribute
instance-attribute
¶
name: str | None = None
The name of the secret that the resource-based policy was retrieved for.
class-attribute
instance-attribute
¶
resource_policy: str | None = None
A JSON-formatted string that contains the permissions policy attached to the secret. For more information about permissions policies, see Authentication and access control for Secrets Manager.