Module: Aws::IoTJobsDataPlane::ClientApi Private

Includes:: Seahorse::Model

Defined in:: lib/aws-sdk-iotjobsdataplane/client_api.rb

This module is part of a private API. You should avoid using this module if possible, as it may be removed or be changed in the future.

Constant Summary collapse

ApproximateSecondsBeforeTimedOut =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::IntegerShape.new(name: 'ApproximateSecondsBeforeTimedOut')

BinaryBlob =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::BlobShape.new(name: 'BinaryBlob')

BinaryParameterValue =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::BlobShape.new(name: 'BinaryParameterValue')

BooleanParameterValue =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::BooleanShape.new(name: 'BooleanParameterValue')

CertificateValidationException =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::StructureShape.new(name: 'CertificateValidationException')

ClientRequestTokenV2 =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::StringShape.new(name: 'ClientRequestTokenV2')

CommandArn =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::StringShape.new(name: 'CommandArn')

CommandExecutionId =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::StringShape.new(name: 'CommandExecutionId')

CommandExecutionParameterMap =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::MapShape.new(name: 'CommandExecutionParameterMap')

CommandExecutionTimeoutInSeconds =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::IntegerShape.new(name: 'CommandExecutionTimeoutInSeconds')

CommandParameterName =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::StringShape.new(name: 'CommandParameterName')

CommandParameterValue =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::StructureShape.new(name: 'CommandParameterValue')

ConflictException =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::StructureShape.new(name: 'ConflictException')

DescribeJobExecutionJobId =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::StringShape.new(name: 'DescribeJobExecutionJobId')

DescribeJobExecutionRequest =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::StructureShape.new(name: 'DescribeJobExecutionRequest')

DescribeJobExecutionResponse =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::StructureShape.new(name: 'DescribeJobExecutionResponse')

DetailsKey =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::StringShape.new(name: 'DetailsKey')

DetailsMap =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::MapShape.new(name: 'DetailsMap')

DetailsValue =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::StringShape.new(name: 'DetailsValue')

DoubleParameterValue =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::FloatShape.new(name: 'DoubleParameterValue')

ExecutionNumber =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::IntegerShape.new(name: 'ExecutionNumber')

ExpectedVersion =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::IntegerShape.new(name: 'ExpectedVersion')

GetPendingJobExecutionsRequest =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::StructureShape.new(name: 'GetPendingJobExecutionsRequest')

GetPendingJobExecutionsResponse =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::StructureShape.new(name: 'GetPendingJobExecutionsResponse')

IncludeExecutionState =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::BooleanShape.new(name: 'IncludeExecutionState')

IncludeJobDocument =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::BooleanShape.new(name: 'IncludeJobDocument')

IntegerParameterValue =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::IntegerShape.new(name: 'IntegerParameterValue')

InternalServerException =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::StructureShape.new(name: 'InternalServerException')

InvalidRequestException =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::StructureShape.new(name: 'InvalidRequestException')

InvalidStateTransitionException =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::StructureShape.new(name: 'InvalidStateTransitionException')

JobDocument =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::StringShape.new(name: 'JobDocument')

JobExecution =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::StructureShape.new(name: 'JobExecution')

JobExecutionState =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::StructureShape.new(name: 'JobExecutionState')

JobExecutionStatus =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::StringShape.new(name: 'JobExecutionStatus')

JobExecutionSummary =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::StructureShape.new(name: 'JobExecutionSummary')

JobExecutionSummaryList =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::ListShape.new(name: 'JobExecutionSummaryList')

JobId =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::StringShape.new(name: 'JobId')

LastUpdatedAt =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::IntegerShape.new(name: 'LastUpdatedAt')

LongParameterValue =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::IntegerShape.new(name: 'LongParameterValue')

QueuedAt =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::IntegerShape.new(name: 'QueuedAt')

ResourceNotFoundException =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::StructureShape.new(name: 'ResourceNotFoundException')

ServiceQuotaExceededException =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::StructureShape.new(name: 'ServiceQuotaExceededException')

ServiceUnavailableException =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::StructureShape.new(name: 'ServiceUnavailableException')

StartCommandExecutionRequest =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::StructureShape.new(name: 'StartCommandExecutionRequest')

StartCommandExecutionResponse =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::StructureShape.new(name: 'StartCommandExecutionResponse')

StartNextPendingJobExecutionRequest =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::StructureShape.new(name: 'StartNextPendingJobExecutionRequest')

StartNextPendingJobExecutionResponse =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::StructureShape.new(name: 'StartNextPendingJobExecutionResponse')

StartedAt =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::IntegerShape.new(name: 'StartedAt')

StepTimeoutInMinutes =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::IntegerShape.new(name: 'StepTimeoutInMinutes')

StringParameterValue =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::StringShape.new(name: 'StringParameterValue')

TargetArn =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::StringShape.new(name: 'TargetArn')

TerminalStateException =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::StructureShape.new(name: 'TerminalStateException')

ThingName =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::StringShape.new(name: 'ThingName')

ThrottlingException =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::StructureShape.new(name: 'ThrottlingException')

UnsignedLongParameterValue =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::StringShape.new(name: 'UnsignedLongParameterValue')

UpdateJobExecutionRequest =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::StructureShape.new(name: 'UpdateJobExecutionRequest')

UpdateJobExecutionResponse =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::StructureShape.new(name: 'UpdateJobExecutionResponse')

ValidationException =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::StructureShape.new(name: 'ValidationException')

VersionNumber =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Shapes::IntegerShape.new(name: 'VersionNumber')

API =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Seahorse::Model::Api.new.tap do |api|

  api.version = "2017-09-29"

  api.metadata = {
    "apiVersion" => "2017-09-29",
    "auth" => ["aws.auth#sigv4"],
    "endpointPrefix" => "data.jobs.iot",
    "protocol" => "rest-json",
    "protocols" => ["rest-json"],
    "serviceFullName" => "AWS IoT Jobs Data Plane",
    "serviceId" => "IoT Jobs Data Plane",
    "signatureVersion" => "v4",
    "signingName" => "iot-jobs-data",
    "uid" => "iot-jobs-data-2017-09-29",
  }

  api.add_operation(:describe_job_execution, Seahorse::Model::Operation.new.tap do |o|
    o.name = "DescribeJobExecution"
    o.http_method = "GET"
    o.http_request_uri = "/things/{thingName}/jobs/{jobId}"
    o.input = Shapes::ShapeRef.new(shape: DescribeJobExecutionRequest)
    o.output = Shapes::ShapeRef.new(shape: DescribeJobExecutionResponse)
    o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
    o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
    o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
    o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
    o.errors << Shapes::ShapeRef.new(shape: CertificateValidationException)
    o.errors << Shapes::ShapeRef.new(shape: TerminalStateException)
  end)

  api.add_operation(:get_pending_job_executions, Seahorse::Model::Operation.new.tap do |o|
    o.name = "GetPendingJobExecutions"
    o.http_method = "GET"
    o.http_request_uri = "/things/{thingName}/jobs"
    o.input = Shapes::ShapeRef.new(shape: GetPendingJobExecutionsRequest)
    o.output = Shapes::ShapeRef.new(shape: GetPendingJobExecutionsResponse)
    o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
    o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
    o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
    o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
    o.errors << Shapes::ShapeRef.new(shape: CertificateValidationException)
  end)

  api.add_operation(:start_command_execution, Seahorse::Model::Operation.new.tap do |o|
    o.name = "StartCommandExecution"
    o.http_method = "POST"
    o.http_request_uri = "/command-executions"
    o.input = Shapes::ShapeRef.new(shape: StartCommandExecutionRequest)
    o.output = Shapes::ShapeRef.new(shape: StartCommandExecutionResponse)
    o.errors << Shapes::ShapeRef.new(shape: ValidationException)
    o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
    o.errors << Shapes::ShapeRef.new(shape: ConflictException)
    o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
    o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException)
    o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
  end)

  api.add_operation(:start_next_pending_job_execution, Seahorse::Model::Operation.new.tap do |o|
    o.name = "StartNextPendingJobExecution"
    o.http_method = "PUT"
    o.http_request_uri = "/things/{thingName}/jobs/$next"
    o.input = Shapes::ShapeRef.new(shape: StartNextPendingJobExecutionRequest)
    o.output = Shapes::ShapeRef.new(shape: StartNextPendingJobExecutionResponse)
    o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
    o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
    o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
    o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
    o.errors << Shapes::ShapeRef.new(shape: CertificateValidationException)
  end)

  api.add_operation(:update_job_execution, Seahorse::Model::Operation.new.tap do |o|
    o.name = "UpdateJobExecution"
    o.http_method = "POST"
    o.http_request_uri = "/things/{thingName}/jobs/{jobId}"
    o.input = Shapes::ShapeRef.new(shape: UpdateJobExecutionRequest)
    o.output = Shapes::ShapeRef.new(shape: UpdateJobExecutionResponse)
    o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
    o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
    o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
    o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
    o.errors << Shapes::ShapeRef.new(shape: CertificateValidationException)
    o.errors << Shapes::ShapeRef.new(shape: InvalidStateTransitionException)
  end)
end