put_resource_policy¶
Operation¶
put_resource_policy
¶
put_resource_policy(request: PutResourcePolicyInput | PutResourcePolicyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[PutResourcePolicyInputDict]) -> PutResourcePolicyOutput
Attaches a resource-based policy to a data stream or registered
consumer. If you are using an identity other than the root user of the
Amazon Web Services account that owns the resource, the calling identity
must have the PutResourcePolicy permissions on the specified Kinesis
Data Streams resource and belong to the owner's account in order to use
this operation. If you don't have PutResourcePolicy permissions,
Amazon Kinesis Data Streams returns a 403 Access Denied error. If you
receive a ResourceNotFoundException, check to see if you passed a
valid stream or consumer resource.
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]+
For more information, see Controlling Access to Amazon Kinesis Data Streams Resources Using IAM.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
PutResourcePolicyInput | PutResourcePolicyInputDict | 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[PutResourcePolicyInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
PutResourcePolicyOutput
|
An instance of |
put_resource_policy
async
¶
put_resource_policy(request: PutResourcePolicyInput | PutResourcePolicyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[PutResourcePolicyInputDict]) -> PutResourcePolicyOutput
Attaches a resource-based policy to a data stream or registered
consumer. If you are using an identity other than the root user of the
Amazon Web Services account that owns the resource, the calling identity
must have the PutResourcePolicy permissions on the specified Kinesis
Data Streams resource and belong to the owner's account in order to use
this operation. If you don't have PutResourcePolicy permissions,
Amazon Kinesis Data Streams returns a 403 Access Denied error. If you
receive a ResourceNotFoundException, check to see if you passed a
valid stream or consumer resource.
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]+
For more information, see Controlling Access to Amazon Kinesis Data Streams Resources Using IAM.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
PutResourcePolicyInput | PutResourcePolicyInputDict | 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[PutResourcePolicyInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
PutResourcePolicyOutput
|
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.
PutResourcePolicyInputDict
¶
Bases: TypedDict
Dictionary form of PutResourcePolicyInput.
PutResourcePolicyInput
dataclass
¶
Bases: _SerdeShape
Dataclass for PutResourcePolicyInput structure.
Attributes¶
policy
class-attribute
instance-attribute
¶
policy: str | None = ...
Details of the resource policy. It must include the identity of the principal and the actions allowed on this resource. This is formatted as a JSON string.
Output¶
PutResourcePolicyOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for PutResourcePolicyOutput structure.