Skip to content

start_export

start_export(
    s3_bucket: S3BucketName,
    s3_key: S3Key,
    *,
    config_overrides: Optional[mgnClientConfig] = None,
    s3_bucket_owner: Optional[AccountID] = None,
    tags: Optional[TagsMap] = None,
) -> StartExportResponse

Start export.

Parameters:

  • s3_bucket (S3BucketName) –

    Start export request s3 bucket.

  • s3_key (S3Key) –

    Start export request s3key.

  • s3_bucket_owner (Optional[AccountID], default: None ) –

    Start export request s3 bucket owner.

  • tags (Optional[TagsMap], default: None ) –

    Start export request tags.

Raises:

Source code in docs_src/capo_mgn/_services/mgn.py
def start_export(
    self,
    s3_bucket: "capo_mgn.types.s3_bucket_name.S3BucketName",
    s3_key: "capo_mgn.types.s3_key.S3Key",
    *,
    config_overrides: Optional[mgnClientConfig] = None,
    s3_bucket_owner: Optional["capo_mgn.types.account_id.AccountID"] = None,
    tags: Optional["capo_mgn.types.tags_map.TagsMap"] = None,
) -> "capo_mgn.types.start_export_response.StartExportResponse":
    """<p>Start export.</p>

    Args:
        s3_bucket: <p>Start export request s3 bucket.</p>
        s3_key: <p>Start export request s3key.</p>
        s3_bucket_owner: <p>Start export request s3 bucket owner.</p>
        tags: <p>Start export request tags.</p>

    Raises:
        capo_mgn.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request could not be completed because it exceeded the service quota.</p>
        capo_mgn.errors.uninitialized_account_exception.UninitializedAccountException: <p>Uninitialized account exception.</p>
        capo_mgn.errors.validation_exception.ValidationException: <p>Validate exception.</p>
        capo_mgn.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_mgn.types.start_export_request.StartExportRequest]",
    ) -> OperationResponse[
        "capo_mgn.types.start_export_response.StartExportResponse"
    ]:
        import capo_mgn._operations.application_migration_service.start_export

        output, http_response = (
            capo_mgn._operations.application_migration_service.start_export.start_export(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_mgn.types.start_export_request.StartExportRequest",
    ) -> dict[str, Any]:
        import capo_mgn.types.start_export_request

        return capo_mgn.types.start_export_request.redact_sensitive(input_)

    def _redact_output(
        output: "capo_mgn.types.start_export_response.StartExportResponse",
    ) -> dict[str, Any]:
        import capo_mgn.types.start_export_response

        return capo_mgn.types.start_export_response.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "StartExport", redact_input=_redact_input, redact_output=_redact_output
        ),
    )
    input_: capo_mgn.types.start_export_request.StartExportRequest = {
        "s3_bucket": s3_bucket,
        "s3_key": s3_key,
    }
    if s3_bucket_owner is not None:
        input_["s3_bucket_owner"] = s3_bucket_owner
    if tags is not None:
        input_["tags"] = tags

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