Skip to content

Kinesis  >  Operations  >  get_resource_policy

get_resource_policy

Operation

get_resource_policy async

get_resource_policy(request: GetResourcePolicyInput | GetResourcePolicyInputDict, /, *, plugins: list[Plugin] | None = None) -> GetResourcePolicyOutput
get_resource_policy(*, 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
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 GetResourcePolicyOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

GetResourcePolicyInput dataclass

Bases: _SerdeShape

Dataclass for GetResourcePolicyInput structure.

Attributes
resource_arn class-attribute instance-attribute
resource_arn: str | None = ...

The Amazon Resource Name (ARN) of the data stream or consumer.

stream_id class-attribute instance-attribute
stream_id: str | None = ...

Not Implemented. Reserved for future use.

Dictionaries

GetResourcePolicyInputDict

Bases: TypedDict

Dictionary form of GetResourcePolicyInput.

Attributes
resource_arn instance-attribute
resource_arn: Required[str]

The Amazon Resource Name (ARN) of the data stream or consumer.

stream_id instance-attribute
stream_id: str | None

Not Implemented. Reserved for future use.

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
response_metadata: ResponseMetadata = ...

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.