get_resource_policy¶
Operation¶
get_resource_policy
¶
get_resource_policy(request: GetResourcePolicyInput | GetResourcePolicyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetResourcePolicyInputDict]) -> 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 |
|---|---|---|---|
request
|
GetResourcePolicyInput | GetResourcePolicyInputDict | 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[GetResourcePolicyInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetResourcePolicyOutput
|
An instance of |
get_resource_policy
async
¶
get_resource_policy(request: GetResourcePolicyInput | GetResourcePolicyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetResourcePolicyInputDict]) -> 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 |
|---|---|---|---|
request
|
GetResourcePolicyInput | GetResourcePolicyInputDict | 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[GetResourcePolicyInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetResourcePolicyOutput
|
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.
GetResourcePolicyInputDict
¶
Bases: TypedDict
Dictionary form of GetResourcePolicyInput.
Attributes¶
policy_name
instance-attribute
¶
policy_name: str | None
The name of the resource policy to retrieve. If you don't specify this
field, Secrets Manager uses default. If you specify a name other than
default and no policy with that name exists, the operation returns a
ResourceNotFoundException.
secret_id
instance-attribute
¶
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.
GetResourcePolicyInput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetResourcePolicyInput structure.
Attributes¶
policy_name
class-attribute
instance-attribute
¶
policy_name: str | None = ...
The name of the resource policy to retrieve. If you don't specify this
field, Secrets Manager uses default. If you specify a name other than
default and no policy with that name exists, the operation returns a
ResourceNotFoundException.
secret_id
class-attribute
instance-attribute
¶
secret_id: str | 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¶
GetResourcePolicyOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetResourcePolicyOutput structure.
Attributes¶
arn
class-attribute
instance-attribute
¶
arn: str | None = ...
The ARN of the secret that the resource-based policy was retrieved for.
name
class-attribute
instance-attribute
¶
name: str | None = ...
The name of the secret that the resource-based policy was retrieved for.
policy_name
class-attribute
instance-attribute
¶
policy_name: str | None = ...
The name of the resource policy. If you didn't specify PolicyName in
the request, this is default.
resource_policy
class-attribute
instance-attribute
¶
resource_policy: str | 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.
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.