SSM / Client / delete_resource_policy

delete_resource_policy

SSM.Client.delete_resource_policy(**kwargs)

Deletes a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. The following resources support Systems Manager resource policies.

  • OpsItemGroup - The resource policy for OpsItemGroup enables Amazon Web Services accounts to view and interact with OpsCenter operational work items (OpsItems).

  • Parameter - The resource policy is used to share a parameter with other accounts using Resource Access Manager (RAM). For more information about cross-account sharing of parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.

  • Document – Shares the document using Resource Access Manager (RAM). For more information about sharing documents, see Sharing Systems Manager documents in the Amazon Web Services Systems Manager User Guide.

See also: AWS API Documentation

Request Syntax

response = client.delete_resource_policy(
    ResourceArn='string',
    PolicyId='string',
    PolicyHash='string',
    DeletionMode='RemoveSharing'|'RollbackMigration'
)
Parameters:

  • ResourceArn (string) –

    [REQUIRED]

    Amazon Resource Name (ARN) of the resource to which the policies are attached.

  • PolicyId (string) –

    [REQUIRED]

    The policy ID.

  • PolicyHash (string) –

    [REQUIRED]

    ID of the current policy version. The hash helps to prevent multiple calls from attempting to overwrite a policy.

  • DeletionMode (string) –

    Specifies the intended outcome of the operation. Applies only to the Document resource type. The operation ignores this parameter for other resource types. Optional. Defaults to RemoveSharing.

    • RemoveSharing – Deletes the resource policy and removes sharing of the document.

    • RollbackMigration – Reverts the document to Custom sharing, preserving existing consumer access, instead of removing the policy.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions