get_resource_policy¶
Operation¶
get_resource_policy
¶
get_resource_policy(request: GetResourcePolicyInput | GetResourcePolicyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetResourcePolicyInputDict]) -> GetResourcePolicyOutput
Returns a policy attached to the specified data stream or consumer. Request patterns can be one of the following:
-
Data stream pattern:
arn:aws.*:kinesis:.*:\d{12}:.*stream/\S+ -
Consumer pattern:
^(arn):aws.*:kinesis:.*:\d{12}:.*stream\/[a-zA-Z0-9_.-]+\/consumer\/[a-zA-Z0-9_.-]+:[0-9]+
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
Returns a policy attached to the specified data stream or consumer. Request patterns can be one of the following:
-
Data stream pattern:
arn:aws.*:kinesis:.*:\d{12}:.*stream/\S+ -
Consumer pattern:
^(arn):aws.*:kinesis:.*:\d{12}:.*stream\/[a-zA-Z0-9_.-]+\/consumer\/[a-zA-Z0-9_.-]+:[0-9]+
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.
Output¶
GetResourcePolicyOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetResourcePolicyOutput structure.
Attributes¶
policy
instance-attribute
¶
policy: str
Details of the resource policy. This is formatted as a JSON string.
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.