delete_role_policy `async` ¶

delete_role_policy(
    role_name: roleNameType,
    policy_name: policyNameType,
    *,
    config_overrides: Optional[AsyncIAMClientConfig] = None,
) -> None

Deletes the specified inline policy that is embedded in the specified IAM role.

A role can also have managed policies attached to it. To detach a managed policy from a role, use DetachRolePolicy. For more information about policies, refer to Managed policies and inline policies in the IAM User Guide.

Parameters:

role_name (roleNameType) –

The name (friendly name, not ARN) identifying the role that the policy is embedded in.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
policy_name (policyNameType) –

The name of the inline policy to delete from the specified IAM role.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

Raises:

LimitExceededException –

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
NoSuchEntityException –

The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
ServiceFailureException –

The request processing has failed because of an unknown error, exception or failure.
UnmodifiableEntityException –

The request was rejected because service-linked roles are protected Amazon Web Services resources. Only the service that depends on the service-linked role can modify or delete the role on your behalf. The error message includes the name of the service that depends on this service-linked role. You must request the change through that service.
UnknownServiceError –

The service returned an error code this client does not model.

Examples:

To remove a policy from an IAM role The following command removes the policy named ExamplePolicy from the role named Test-Role.

>>> await client.delete_role_policy(role_name='Test-Role', policy_name='ExamplePolicy')

Source code in docs_src/capo_iam/_services/async_iam.py

async def delete_role_policy(
    self,
    role_name: "capo_iam.types.role_name_type.roleNameType",
    policy_name: "capo_iam.types.policy_name_type.policyNameType",
    *,
    config_overrides: Optional[AsyncIAMClientConfig] = None,
) -> None:
    """<p>Deletes the specified inline policy that is embedded in the specified IAM role.</p> <p>A role can also have managed policies attached to it. To detach a managed policy from a role, use <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_DetachRolePolicy.html">DetachRolePolicy</a>. For more information about policies, refer to <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p>

    Args:
        role_name: <p>The name (friendly name, not ARN) identifying the role that the policy is embedded in.</p> <p>This parameter allows (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-</p>
        policy_name: <p>The name of the inline policy to delete from the specified IAM role.</p> <p>This parameter allows (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-</p>

    Raises:
        capo_iam.errors.limit_exceeded_exception.LimitExceededException: <p>The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.</p>
        capo_iam.errors.no_such_entity_exception.NoSuchEntityException: <p>The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.</p>
        capo_iam.errors.service_failure_exception.ServiceFailureException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_iam.errors.unmodifiable_entity_exception.UnmodifiableEntityException: <p>The request was rejected because service-linked roles are protected Amazon Web Services resources. Only the service that depends on the service-linked role can modify or delete the role on your behalf. The error message includes the name of the service that depends on this service-linked role. You must request the change through that service.</p>
        capo_iam.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To remove a policy from an IAM role
        The following command removes the policy named ExamplePolicy from the role named Test-Role.

        >>> await client.delete_role_policy(role_name='Test-Role', policy_name='ExamplePolicy')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_iam.types.delete_role_policy_request.DeleteRolePolicyRequest]",
    ) -> AsyncOperationResponse[None]:
        import capo_iam._operations.aws_identity_management_v20100508.delete_role_policy

        (
            output,
            http_response,
        ) = await capo_iam._operations.aws_identity_management_v20100508.delete_role_policy.async_delete_role_policy(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteRolePolicy")
    )
    input_: capo_iam.types.delete_role_policy_request.DeleteRolePolicyRequest = {
        "role_name": role_name,
        "policy_name": policy_name,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

delete_role_policy async ¶

delete_role_policy `async` ¶