Skip to content

describe_location_s3

describe_location_s3(
    location_arn: LocationArn,
    *,
    config_overrides: Optional[DataSyncClientConfig] = None,
) -> DescribeLocationS3Response

Provides details about how an DataSync transfer location for an S3 bucket is configured.

Parameters:

  • location_arn (LocationArn) –

    Specifies the Amazon Resource Name (ARN) of the Amazon S3 location.

Raises:

Source code in docs_src/capo_datasync/_services/data_sync.py
def describe_location_s3(
    self,
    location_arn: "capo_datasync.types.location_arn.LocationArn",
    *,
    config_overrides: Optional[DataSyncClientConfig] = None,
) -> "capo_datasync.types.describe_location_s3_response.DescribeLocationS3Response":
    """<p>Provides details about how an DataSync transfer location for an S3 bucket is configured.</p>

    Args:
        location_arn: <p>Specifies the Amazon Resource Name (ARN) of the Amazon S3 location.</p>

    Raises:
        capo_datasync.errors.internal_exception.InternalException: <p>This exception is thrown when an error occurs in the DataSync service.</p>
        capo_datasync.errors.invalid_request_exception.InvalidRequestException: <p>This exception is thrown when the client submits a malformed request.</p>
        capo_datasync.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_datasync.types.describe_location_s3_request.DescribeLocationS3Request]",
    ) -> OperationResponse[
        "capo_datasync.types.describe_location_s3_response.DescribeLocationS3Response"
    ]:
        import capo_datasync._operations.fmrs_service.describe_location_s3

        output, http_response = (
            capo_datasync._operations.fmrs_service.describe_location_s3.describe_location_s3(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeLocationS3")
    )
    input_: capo_datasync.types.describe_location_s3_request.DescribeLocationS3Request = {
        "location_arn": location_arn
    }

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