Skip to content

get_allow_list 

get_allow_list(
    id: __string, *, config_overrides: Optional[Macie2ClientConfig] = None
) -> GetAllowListResponse

Retrieves the settings and status of an allow list.

Parameters:

  • id (__string) –

    The unique identifier for the Amazon Macie resource that the request applies to.

Raises:

  • AccessDeniedException –

    Provides information about an error that occurred due to insufficient access to a specified resource.

  • InternalServerException –

    Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

  • ResourceNotFoundException –

    Provides information about an error that occurred because a specified resource wasn't found.

  • ThrottlingException –

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ValidationException –

    Provides information about an error that occurred due to a syntax error in a request.

  • UnknownServiceError –

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

Source code in docs_src/capo_macie2/_services/macie2.py 
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
def get_allow_list(
    self,
    id: "capo_macie2.types.__string.__string",
    *,
    config_overrides: Optional[Macie2ClientConfig] = None,
) -> "capo_macie2.types.get_allow_list_response.GetAllowListResponse":
    """<p>Retrieves the settings and status of an allow list.</p>

    Args:
        id: <p>The unique identifier for the Amazon Macie resource that the request applies to.</p>

    Raises:
        capo_macie2.errors.access_denied_exception.AccessDeniedException: <p>Provides information about an error that occurred due to insufficient access to a specified resource.</p>
        capo_macie2.errors.internal_server_exception.InternalServerException: <p>Provides information about an error that occurred due to an unknown internal server error, exception, or failure.</p>
        capo_macie2.errors.resource_not_found_exception.ResourceNotFoundException: <p>Provides information about an error that occurred because a specified resource wasn't found.</p>
        capo_macie2.errors.throttling_exception.ThrottlingException: <p>Provides information about an error that occurred because too many requests were sent during a certain amount of time.</p>
        capo_macie2.errors.validation_exception.ValidationException: <p>Provides information about an error that occurred due to a syntax error in a request.</p>
        capo_macie2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_macie2.types.get_allow_list_request.GetAllowListRequest]",
    ) -> OperationResponse[
        "capo_macie2.types.get_allow_list_response.GetAllowListResponse"
    ]:
        import capo_macie2._operations.macie2.get_allow_list

        output, http_response = (
            capo_macie2._operations.macie2.get_allow_list.get_allow_list(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetAllowList")
    )
    input_: capo_macie2.types.get_allow_list_request.GetAllowListRequest = {
        "id": id
    }

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