get_trail ¶

get_trail(
    name: String, *, config_overrides: Optional[CloudTrailClientConfig] = None
) -> GetTrailResponse

Returns settings information for a specified trail.

Parameters:

name (String) –

The name or the Amazon Resource Name (ARN) of the trail for which you want to retrieve settings information.

Raises:

CloudTrailARNInvalidException –

This exception is thrown when an operation is called with an ARN that is not valid.

The following is the format of a trail ARN: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

The following is the format of an event data store ARN: arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE

The following is the format of a dashboard ARN: arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash

The following is the format of a channel ARN: arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
InvalidTrailNameException –
This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements:
- Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
- Start with a letter or number, and end with a letter or number
- Be between 3 and 128 characters
- Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are not valid.
- Not be in IP address format (for example, 192.168.5.4)
OperationNotPermittedException –

This exception is thrown when the requested operation is not permitted.
TrailNotFoundException –

This exception is thrown when the trail with the given name is not found.
UnsupportedOperationException –

This exception is thrown when the requested operation is not supported.
UnknownServiceError –

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

Source code in docs_src/capo_cloudtrail/_services/cloud_trail.py

def get_trail(
    self,
    name: "capo_cloudtrail.types.string.String",
    *,
    config_overrides: Optional[CloudTrailClientConfig] = None,
) -> "capo_cloudtrail.types.get_trail_response.GetTrailResponse":
    """<p>Returns settings information for a specified trail.</p>

    Args:
        name: <p>The name or the Amazon Resource Name (ARN) of the trail for which you want to retrieve settings information.</p>

    Raises:
        capo_cloudtrail.errors.cloud_trail_arn_invalid_exception.CloudTrailARNInvalidException: <p>This exception is thrown when an operation is called with an ARN that is not valid.</p> <p>The following is the format of a trail ARN: <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code> </p> <p>The following is the format of an event data store ARN: <code>arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE</code> </p> <p>The following is the format of a dashboard ARN: <code>arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash</code> </p> <p>The following is the format of a channel ARN: <code>arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890</code> </p>
        capo_cloudtrail.errors.invalid_trail_name_exception.InvalidTrailNameException: <p>This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements:</p> <ul> <li> <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</p> </li> <li> <p>Start with a letter or number, and end with a letter or number</p> </li> <li> <p>Be between 3 and 128 characters</p> </li> <li> <p>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are not valid.</p> </li> <li> <p>Not be in IP address format (for example, 192.168.5.4)</p> </li> </ul>
        capo_cloudtrail.errors.operation_not_permitted_exception.OperationNotPermittedException: <p>This exception is thrown when the requested operation is not permitted.</p>
        capo_cloudtrail.errors.trail_not_found_exception.TrailNotFoundException: <p>This exception is thrown when the trail with the given name is not found.</p>
        capo_cloudtrail.errors.unsupported_operation_exception.UnsupportedOperationException: <p>This exception is thrown when the requested operation is not supported.</p>
        capo_cloudtrail.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_cloudtrail.types.get_trail_request.GetTrailRequest]",
    ) -> OperationResponse[
        "capo_cloudtrail.types.get_trail_response.GetTrailResponse"
    ]:
        import capo_cloudtrail._operations.cloud_trail_20131101.get_trail

        output, http_response = (
            capo_cloudtrail._operations.cloud_trail_20131101.get_trail.get_trail(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetTrail")
    )
    input_: capo_cloudtrail.types.get_trail_request.GetTrailRequest = {"name": name}

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