Method: Aws::Drs::Client#describe_jobs

Defined in:

lib/aws-sdk-drs/client.rb

#describe_jobs(params = {}) ⇒ Types::DescribeJobsResponse

Returns a list of Jobs. Use the JobsID and fromDate and toDate filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are created by the StartRecovery, TerminateRecoveryInstances and StartFailbackLaunch APIs. Jobs are also created by DiagnosticLaunch and TerminateDiagnosticInstances, which are APIs available only to Support and only used in response to relevant support tickets.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values

resp = client.describe_jobs({
  filters: {
    from_date: "ISO8601DatetimeString",
    job_i_ds: ["JobID"],
    to_date: "ISO8601DatetimeString",
  },
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure

resp.items #=> Array
resp.items[0].arn #=> String
resp.items[0].creation_date_time #=> String
resp.items[0].end_date_time #=> String
resp.items[0].initiated_by #=> String, one of "START_RECOVERY", "START_DRILL", "FAILBACK", "DIAGNOSTIC", "TERMINATE_RECOVERY_INSTANCES", "TARGET_ACCOUNT", "CREATE_NETWORK_RECOVERY", "UPDATE_NETWORK_RECOVERY", "ASSOCIATE_NETWORK_RECOVERY"
resp.items[0].job_id #=> String
resp.items[0].participating_resources #=> Array
resp.items[0].participating_resources[0].launch_status #=> String, one of "PENDING", "IN_PROGRESS", "LAUNCHED", "FAILED", "TERMINATED"
resp.items[0].participating_resources[0].participating_resource_id.source_network_id #=> String
resp.items[0].participating_servers #=> Array
resp.items[0].participating_servers[0].launch_actions_status.runs #=> Array
resp.items[0].participating_servers[0].launch_actions_status.runs[0].action.action_code #=> String
resp.items[0].participating_servers[0].launch_actions_status.runs[0].action.action_id #=> String
resp.items[0].participating_servers[0].launch_actions_status.runs[0].action.action_version #=> String
resp.items[0].participating_servers[0].launch_actions_status.runs[0].action.active #=> Boolean
resp.items[0].participating_servers[0].launch_actions_status.runs[0].action.category #=> String, one of "MONITORING", "VALIDATION", "CONFIGURATION", "SECURITY", "OTHER"
resp.items[0].participating_servers[0].launch_actions_status.runs[0].action.description #=> String
resp.items[0].participating_servers[0].launch_actions_status.runs[0].action.name #=> String
resp.items[0].participating_servers[0].launch_actions_status.runs[0].action.optional #=> Boolean
resp.items[0].participating_servers[0].launch_actions_status.runs[0].action.order #=> Integer
resp.items[0].participating_servers[0].launch_actions_status.runs[0].action.parameters #=> Hash
resp.items[0].participating_servers[0].launch_actions_status.runs[0].action.parameters["LaunchActionParameterName"].type #=> String, one of "SSM_STORE", "DYNAMIC"
resp.items[0].participating_servers[0].launch_actions_status.runs[0].action.parameters["LaunchActionParameterName"].value #=> String
resp.items[0].participating_servers[0].launch_actions_status.runs[0].action.type #=> String, one of "SSM_AUTOMATION", "SSM_COMMAND"
resp.items[0].participating_servers[0].launch_actions_status.runs[0].failure_reason #=> String
resp.items[0].participating_servers[0].launch_actions_status.runs[0].run_id #=> String
resp.items[0].participating_servers[0].launch_actions_status.runs[0].status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED"
resp.items[0].participating_servers[0].launch_actions_status.ssm_agent_discovery_datetime #=> String
resp.items[0].participating_servers[0].launch_status #=> String, one of "PENDING", "IN_PROGRESS", "LAUNCHED", "FAILED", "TERMINATED"
resp.items[0].participating_servers[0].recovery_instance_id #=> String
resp.items[0].participating_servers[0].source_server_id #=> String
resp.items[0].status #=> String, one of "PENDING", "STARTED", "COMPLETED"
resp.items[0].tags #=> Hash
resp.items[0].tags["TagKey"] #=> String
resp.items[0].type #=> String, one of "LAUNCH", "TERMINATE", "CREATE_CONVERTED_SNAPSHOT"
resp.next_token #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :filters (Types::DescribeJobsRequestFilters) —

  A set of filters by which to return Jobs.

• :max_results (Integer) —

  Maximum number of Jobs to retrieve.

• :next_token (String) —

  The token of the next Job to retrieve.

Returns:

• (Types::DescribeJobsResponse) —

  Returns a response object which responds to the following methods:

  • #items => Array<Types::Job>

  • #next_token => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-drs/client.rb', line 1183

def describe_jobs(params = {}, options = {})
  req = build_request(:describe_jobs, params)
  req.send_request(options)
end