Skip to content

get_data_protection_policy

Operation

get_data_protection_policy

get_data_protection_policy(request: GetDataProtectionPolicyInput | GetDataProtectionPolicyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetDataProtectionPolicyInputDict]) -> GetDataProtectionPolicyOutput
Warning

Amazon SNS message data protection is no longer available to new customers. For more information and guidance on alternatives, see Amazon SNS message data protection availability change.

Retrieves the specified inline DataProtectionPolicy document that is stored in the specified Amazon SNS topic.

Parameters:

Name Type Description Default
request GetDataProtectionPolicyInput | GetDataProtectionPolicyInputDict | 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[GetDataProtectionPolicyInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetDataProtectionPolicyOutput

An instance of GetDataProtectionPolicyOutput.

get_data_protection_policy async

get_data_protection_policy(request: GetDataProtectionPolicyInput | GetDataProtectionPolicyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetDataProtectionPolicyInputDict]) -> GetDataProtectionPolicyOutput
Warning

Amazon SNS message data protection is no longer available to new customers. For more information and guidance on alternatives, see Amazon SNS message data protection availability change.

Retrieves the specified inline DataProtectionPolicy document that is stored in the specified Amazon SNS topic.

Parameters:

Name Type Description Default
request GetDataProtectionPolicyInput | GetDataProtectionPolicyInputDict | 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[GetDataProtectionPolicyInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetDataProtectionPolicyOutput

An instance of GetDataProtectionPolicyOutput.

Input

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

GetDataProtectionPolicyInputDict

Bases: TypedDict

Dictionary form of GetDataProtectionPolicyInput.

Attributes

resource_arn instance-attribute
resource_arn: Required[str]

The ARN of the topic whose DataProtectionPolicy you want to get.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

GetDataProtectionPolicyInput dataclass

Bases: _SerdeShape

Dataclass for GetDataProtectionPolicyInput structure.

Attributes

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

The ARN of the topic whose DataProtectionPolicy you want to get.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

Output

GetDataProtectionPolicyOutput dataclass

Bases: _SerdeShape

Dataclass for GetDataProtectionPolicyOutput structure.

Attributes

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

Retrieves the DataProtectionPolicy in JSON string format.

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.