start_export_task async ¶

async def start_export_task(
    self,
    *,
    config_overrides: Optional[AsyncApplicationDiscoveryServiceClientConfig] = None,
    export_data_format: Optional[
        "capo_application_discovery_service.types.export_data_formats.ExportDataFormats"
    ] = None,
    filters: Optional[
        "capo_application_discovery_service.types.export_filters.ExportFilters"
    ] = None,
    start_time: Optional[
        "capo_application_discovery_service.types.time_stamp.TimeStamp"
    ] = None,
    end_time: Optional[
        "capo_application_discovery_service.types.time_stamp.TimeStamp"
    ] = None,
    preferences: Optional[
        "capo_application_discovery_service.types.export_preferences.ExportPreferences"
    ] = None,
) -> "capo_application_discovery_service.types.start_export_task_response.StartExportTaskResponse":
    """<p>Begins the export of a discovered data report to an Amazon S3 bucket managed by Amazon Web Services.</p> <note> <p>Exports might provide an estimate of fees and savings based on certain information that you provide. Fee estimates do not include any taxes that might apply. Your actual fees and savings depend on a variety of factors, including your actual usage of Amazon Web Services services, which might vary from the estimates provided in this report.</p> </note> <p>If you do not specify <code>preferences</code> or <code>agentIds</code> in the filter, a summary of all servers, applications, tags, and performance is generated. This data is an aggregation of all server data collected through on-premises tooling, file import, application grouping and applying tags.</p> <p>If you specify <code>agentIds</code> in a filter, the task exports up to 72 hours of detailed data collected by the identified Application Discovery Agent, including network, process, and performance details. A time range for exported agent data may be set by using <code>startTime</code> and <code>endTime</code>. Export of detailed agent data is limited to five concurrently running exports. Export of detailed agent data is limited to two exports per day.</p> <p>If you enable <code>ec2RecommendationsPreferences</code> in <code>preferences</code> , an Amazon EC2 instance matching the characteristics of each server in Application Discovery Service is generated. Changing the attributes of the <code>ec2RecommendationsPreferences</code> changes the criteria of the recommendation.</p>

    Args:
        export_data_format: <p>The file format for the returned export data. Default value is <code>CSV</code>. <b>Note:</b> <i>The</i> <code>GRAPHML</code> <i>option has been deprecated.</i> </p>
        filters: <p>If a filter is present, it selects the single <code>agentId</code> of the Application Discovery Agent for which data is exported. The <code>agentId</code> can be found in the results of the <code>DescribeAgents</code> API or CLI. If no filter is present, <code>startTime</code> and <code>endTime</code> are ignored and exported data includes both Amazon Web Services Application Discovery Service Agentless Collector collectors data and summary data from Application Discovery Agent agents. </p>
        start_time: <p>The start timestamp for exported data from the single Application Discovery Agent selected in the filters. If no value is specified, data is exported starting from the first data collected by the agent.</p>
        end_time: <p>The end timestamp for exported data from the single Application Discovery Agent selected in the filters. If no value is specified, exported data includes the most recent data collected by the agent.</p>
        preferences: <p> Indicates the type of data that needs to be exported. Only one <a href="https://docs.aws.amazon.com/application-discovery/latest/APIReference/API_ExportPreferences.html">ExportPreferences</a> can be enabled at any time. </p>

    Raises:
        capo_application_discovery_service.errors.authorization_error_exception.AuthorizationErrorException: <p>The user does not have permission to perform the action. Check the IAM policy associated with this user.</p>
        capo_application_discovery_service.errors.home_region_not_set_exception.HomeRegionNotSetException: <p>The home Region is not set. Set the home Region to continue.</p>
        capo_application_discovery_service.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more parameters are not valid. Verify the parameters and try again.</p>
        capo_application_discovery_service.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.</p>
        capo_application_discovery_service.errors.operation_not_permitted_exception.OperationNotPermittedException: <p>This operation is not permitted.</p>
        capo_application_discovery_service.errors.server_internal_error_exception.ServerInternalErrorException: <p>The server experienced an internal error. Try again.</p>
        capo_application_discovery_service.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_application_discovery_service.types.start_export_task_request.StartExportTaskRequest]",
    ) -> AsyncOperationResponse[
        "capo_application_discovery_service.types.start_export_task_response.StartExportTaskResponse"
    ]:
        import capo_application_discovery_service._operations.aws_poseidon_service_v2015_11_01.start_export_task

        (
            output,
            http_response,
        ) = await capo_application_discovery_service._operations.aws_poseidon_service_v2015_11_01.start_export_task.async_start_export_task(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartExportTask")
    )
    input_: capo_application_discovery_service.types.start_export_task_request.StartExportTaskRequest = {}
    if export_data_format is not None:
        input_["export_data_format"] = export_data_format
    if filters is not None:
        input_["filters"] = filters
    if start_time is not None:
        input_["start_time"] = start_time
    if end_time is not None:
        input_["end_time"] = end_time
    if preferences is not None:
        input_["preferences"] = preferences

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output