You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CodePipeline::Types::ThirdPartyJobData

Inherits:

Struct

• Object
• Struct
• Aws::CodePipeline::Types::ThirdPartyJobData

Defined in:

gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb

Overview

Represents information about the job data for a partner action.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #action_configuration ⇒ Types::ActionConfiguration

  Represents information about an action configuration.

• #action_type_id ⇒ Types::ActionTypeId

  Represents information about an action type.

• #artifact_credentials ⇒ Types::AWSSessionCredentials

  Represents an AWS session credentials object.

• #continuation_token ⇒ String

  A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires in order to continue the job asynchronously.

• #encryption_key ⇒ Types::EncryptionKey

  The encryption key used to encrypt and decrypt data in the artifact store for the pipeline, such as an AWS Key Management Service (AWS KMS) key.

• #input_artifacts ⇒ Array<Types::Artifact>

  The name of the artifact that will be worked upon by the action, if any.

• #output_artifacts ⇒ Array<Types::Artifact>

  The name of the artifact that will be the result of the action, if any.

• #pipeline_context ⇒ Types::PipelineContext

  Represents information about a pipeline to a job worker.

Instance Attribute Details

#action_configuration ⇒ Types::ActionConfiguration

Represents information about an action configuration.

Returns:

• (Types::ActionConfiguration)

# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3583

class ThirdPartyJobData < Struct.new(
  :action_type_id,
  :action_configuration,
  :pipeline_context,
  :input_artifacts,
  :output_artifacts,
  :artifact_credentials,
  :continuation_token,
  :encryption_key)
  include Aws::Structure
end

#action_type_id ⇒ Types::ActionTypeId

Represents information about an action type.

Returns:

• (Types::ActionTypeId)

# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3583

class ThirdPartyJobData < Struct.new(
  :action_type_id,
  :action_configuration,
  :pipeline_context,
  :input_artifacts,
  :output_artifacts,
  :artifact_credentials,
  :continuation_token,
  :encryption_key)
  include Aws::Structure
end

#artifact_credentials ⇒ Types::AWSSessionCredentials

Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS Secure Token Service (STS). They can be used to access input and output artifacts in the Amazon S3 bucket used to store artifact for the pipeline in AWS CodePipeline.

Returns:

• (Types::AWSSessionCredentials)

# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3583

class ThirdPartyJobData < Struct.new(
  :action_type_id,
  :action_configuration,
  :pipeline_context,
  :input_artifacts,
  :output_artifacts,
  :artifact_credentials,
  :continuation_token,
  :encryption_key)
  include Aws::Structure
end

#continuation_token ⇒ String

A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires in order to continue the job asynchronously.

Returns:

• (String)

# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3583

class ThirdPartyJobData < Struct.new(
  :action_type_id,
  :action_configuration,
  :pipeline_context,
  :input_artifacts,
  :output_artifacts,
  :artifact_credentials,
  :continuation_token,
  :encryption_key)
  include Aws::Structure
end

#encryption_key ⇒ Types::EncryptionKey

The encryption key used to encrypt and decrypt data in the artifact store for the pipeline, such as an AWS Key Management Service (AWS KMS) key. This is optional and might not be present.

Returns:

• (Types::EncryptionKey)

# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3583

class ThirdPartyJobData < Struct.new(
  :action_type_id,
  :action_configuration,
  :pipeline_context,
  :input_artifacts,
  :output_artifacts,
  :artifact_credentials,
  :continuation_token,
  :encryption_key)
  include Aws::Structure
end

#input_artifacts ⇒ Array<Types::Artifact>

The name of the artifact that will be worked upon by the action, if any. This name might be system-generated, such as "MyApp", or might be defined by the user when the action is created. The input artifact name must match the name of an output artifact generated by an action in an earlier action or stage of the pipeline.

Returns:

• (Array<Types::Artifact>)

# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3583

class ThirdPartyJobData < Struct.new(
  :action_type_id,
  :action_configuration,
  :pipeline_context,
  :input_artifacts,
  :output_artifacts,
  :artifact_credentials,
  :continuation_token,
  :encryption_key)
  include Aws::Structure
end

#output_artifacts ⇒ Array<Types::Artifact>

The name of the artifact that will be the result of the action, if any. This name might be system-generated, such as "MyBuiltApp", or might be defined by the user when the action is created.

Returns:

• (Array<Types::Artifact>)

# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3583

class ThirdPartyJobData < Struct.new(
  :action_type_id,
  :action_configuration,
  :pipeline_context,
  :input_artifacts,
  :output_artifacts,
  :artifact_credentials,
  :continuation_token,
  :encryption_key)
  include Aws::Structure
end

#pipeline_context ⇒ Types::PipelineContext

Represents information about a pipeline to a job worker.

Does not include pipelineArn and pipelineExecutionId for ThirdParty jobs.

Returns:

• (Types::PipelineContext)

# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3583

class ThirdPartyJobData < Struct.new(
  :action_type_id,
  :action_configuration,
  :pipeline_context,
  :input_artifacts,
  :output_artifacts,
  :artifact_credentials,
  :continuation_token,
  :encryption_key)
  include Aws::Structure
end