Skip to content

get_resource_policies

get_resource_policies(
    resource_arn: ResourceArnString,
    *,
    config_overrides: Optional[SSMClientConfig] = None,
    next_token: Optional[String] = None,
    max_results: Optional[ResourcePolicyMaxResults] = None,
) -> GetResourcePoliciesResponse

Returns an array of the Policy object.

Parameters:

  • resource_arn (ResourceArnString) –

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

  • next_token (Optional[String], default: None ) –

    A token to start the list. Use this token to get the next set of results.

  • max_results (Optional[ResourcePolicyMaxResults], default: None ) –

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Raises:

Source code in docs_src/capo_ssm/_services/ssm.py
def get_resource_policies(
    self,
    resource_arn: "capo_ssm.types.resource_arn_string.ResourceArnString",
    *,
    config_overrides: Optional[SSMClientConfig] = None,
    next_token: Optional["capo_ssm.types.string.String"] = None,
    max_results: Optional[
        "capo_ssm.types.resource_policy_max_results.ResourcePolicyMaxResults"
    ] = None,
) -> "capo_ssm.types.get_resource_policies_response.GetResourcePoliciesResponse":
    """<p>Returns an array of the <code>Policy</code> object.</p>

    Args:
        resource_arn: <p>Amazon Resource Name (ARN) of the resource to which the policies are attached.</p>
        next_token: <p>A token to start the list. Use this token to get the next set of results.</p>
        max_results: <p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>

    Raises:
        capo_ssm.errors.internal_server_error.InternalServerError: <p>An error occurred on the server side.</p>
        capo_ssm.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified parameter to be shared could not be found.</p>
        capo_ssm.errors.resource_policy_invalid_parameter_exception.ResourcePolicyInvalidParameterException: <p>One or more parameters specified for the call aren't valid. Verify the parameters and their values and try again.</p>
        capo_ssm.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ssm.types.get_resource_policies_request.GetResourcePoliciesRequest]",
    ) -> OperationResponse[
        "capo_ssm.types.get_resource_policies_response.GetResourcePoliciesResponse"
    ]:
        import capo_ssm._operations.amazon_ssm.get_resource_policies

        output, http_response = (
            capo_ssm._operations.amazon_ssm.get_resource_policies.get_resource_policies(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetResourcePolicies")
    )
    input_: capo_ssm.types.get_resource_policies_request.GetResourcePoliciesRequest = {
        "resource_arn": resource_arn
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output