Class: Aws::CodePipeline::Client

Inherits:
Seahorse::Client::Base show all
Includes:
Aws::ClientStubs
Defined in:
gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb

Overview

An API client for CodePipeline. To construct a client, you need to configure a :region and :credentials.

client = Aws::CodePipeline::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from Aws::ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.aws/credentials

    • ~/.aws/config

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks. Takes effect only when disable_clock_skew_correction is not set.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_clock_skew_correction (Boolean) —

    Used only in standard and adaptive retry modes. When true, the SDK does not apply a clock skew correction, does not update its stored skew from responses, and does not retry clock skew errors. Clock skew correction is enabled by default.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is the default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling Aws::ClientStubs#stub_responses. See Aws::ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::CodePipeline::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::CodePipeline::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



485
486
487
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 485

def initialize(*args)
  super
end

Instance Method Details

#acknowledge_job(params = {}) ⇒ Types::AcknowledgeJobOutput

Returns information about a specified job and whether that job has been received by the job worker. Used for custom actions only.

Examples:

Request syntax with placeholder values


resp = client.acknowledge_job({
  job_id: "JobId", # required
  nonce: "Nonce", # required
})

Response structure


resp.status #=> String, one of "Created", "Queued", "Dispatched", "InProgress", "TimedOut", "Succeeded", "Failed"

Parameters:

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

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The unique system-generated ID of the job for which you want to confirm receipt.

  • :nonce (required, String) —

    A system-generated random number that CodePipeline uses to ensure that the job is being worked on by only one job worker. Get this number from the response of the PollForJobs request that returned this job.

Returns:

See Also:



522
523
524
525
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 522

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

#acknowledge_third_party_job(params = {}) ⇒ Types::AcknowledgeThirdPartyJobOutput

Confirms a job worker has received the specified job. Used for partner actions only.

Examples:

Request syntax with placeholder values


resp = client.acknowledge_third_party_job({
  job_id: "ThirdPartyJobId", # required
  nonce: "Nonce", # required
  client_token: "ClientToken", # required
})

Response structure


resp.status #=> String, one of "Created", "Queued", "Dispatched", "InProgress", "TimedOut", "Succeeded", "Failed"

Parameters:

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

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The unique system-generated ID of the job.

  • :nonce (required, String) —

    A system-generated random number that CodePipeline uses to ensure that the job is being worked on by only one job worker. Get this number from the response to a GetThirdPartyJobDetails request.

  • :client_token (required, String) —

    The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.

Returns:

See Also:



563
564
565
566
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 563

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

#create_custom_action_type(params = {}) ⇒ Types::CreateCustomActionTypeOutput

Creates a new custom action that can be used in all pipelines associated with the Amazon Web Services account. Only used for custom actions.

Examples:

Request syntax with placeholder values


resp = client.create_custom_action_type({
  category: "Source", # required, accepts Source, Build, Deploy, Test, Invoke, Approval, Compute
  provider: "ActionProvider", # required
  version: "Version", # required
  settings: {
    third_party_configuration_url: "Url",
    entity_url_template: "UrlTemplate",
    execution_url_template: "UrlTemplate",
    revision_url_template: "UrlTemplate",
  },
  configuration_properties: [
    {
      name: "ActionConfigurationKey", # required
      required: false, # required
      key: false, # required
      secret: false, # required
      queryable: false,
      description: "Description",
      type: "String", # accepts String, Number, Boolean
    },
  ],
  input_artifact_details: { # required
    minimum_count: 1, # required
    maximum_count: 1, # required
  },
  output_artifact_details: { # required
    minimum_count: 1, # required
    maximum_count: 1, # required
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.action_type.id.category #=> String, one of "Source", "Build", "Deploy", "Test", "Invoke", "Approval", "Compute"
resp.action_type.id.owner #=> String, one of "AWS", "ThirdParty", "Custom"
resp.action_type.id.provider #=> String
resp.action_type.id.version #=> String
resp.action_type.settings.third_party_configuration_url #=> String
resp.action_type.settings.entity_url_template #=> String
resp.action_type.settings.execution_url_template #=> String
resp.action_type.settings.revision_url_template #=> String
resp.action_type.action_configuration_properties #=> Array
resp.action_type.action_configuration_properties[0].name #=> String
resp.action_type.action_configuration_properties[0].required #=> Boolean
resp.action_type.action_configuration_properties[0].key #=> Boolean
resp.action_type.action_configuration_properties[0].secret #=> Boolean
resp.action_type.action_configuration_properties[0].queryable #=> Boolean
resp.action_type.action_configuration_properties[0].description #=> String
resp.action_type.action_configuration_properties[0].type #=> String, one of "String", "Number", "Boolean"
resp.action_type.input_artifact_details.minimum_count #=> Integer
resp.action_type.input_artifact_details.maximum_count #=> Integer
resp.action_type.output_artifact_details.minimum_count #=> Integer
resp.action_type.output_artifact_details.maximum_count #=> Integer
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :category (required, String) —

    The category of the custom action, such as a build action or a test action.

  • :provider (required, String) —

    The provider of the service used in the custom action, such as CodeDeploy.

  • :version (required, String) —

    The version identifier of the custom action.

  • :settings (Types::ActionTypeSettings) —

    URLs that provide users information about this custom action.

  • :configuration_properties (Array<Types::ActionConfigurationProperty>) —

    The configuration properties for the custom action.

    You can refer to a name in the configuration properties of the custom action within the URL templates by following the format of Config:name, as long as the configuration property is both required and not secret. For more information, see Create a Custom Action for a Pipeline.

  • :input_artifact_details (required, Types::ArtifactDetails) —

    The details of the input artifact for the action, such as its commit ID.

  • :output_artifact_details (required, Types::ArtifactDetails) —

    The details of the output artifact of the action, such as its commit ID.

  • :tags (Array<Types::Tag>) —

    The tags for the custom action.

Returns:

See Also:



686
687
688
689
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 686

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

#create_pipeline(params = {}) ⇒ Types::CreatePipelineOutput

Creates a pipeline.

In the pipeline structure, you must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.

Examples:

Request syntax with placeholder values


resp = client.create_pipeline({
  pipeline: { # required
    name: "PipelineName", # required
    role_arn: "RoleArn", # required
    artifact_store: {
      type: "S3", # required, accepts S3
      location: "ArtifactStoreLocation", # required
      encryption_key: {
        id: "EncryptionKeyId", # required
        type: "KMS", # required, accepts KMS
      },
    },
    artifact_stores: {
      "AWSRegionName" => {
        type: "S3", # required, accepts S3
        location: "ArtifactStoreLocation", # required
        encryption_key: {
          id: "EncryptionKeyId", # required
          type: "KMS", # required, accepts KMS
        },
      },
    },
    stages: [ # required
      {
        name: "StageName", # required
        blockers: [
          {
            name: "BlockerName", # required
            type: "Schedule", # required, accepts Schedule
          },
        ],
        actions: [ # required
          {
            name: "ActionName", # required
            action_type_id: { # required
              category: "Source", # required, accepts Source, Build, Deploy, Test, Invoke, Approval, Compute
              owner: "AWS", # required, accepts AWS, ThirdParty, Custom
              provider: "ActionProvider", # required
              version: "Version", # required
            },
            run_order: 1,
            configuration: {
              "ActionConfigurationKey" => "ActionConfigurationValue",
            },
            commands: ["Command"],
            output_artifacts: [
              {
                name: "ArtifactName", # required
                files: ["FilePath"],
              },
            ],
            input_artifacts: [
              {
                name: "ArtifactName", # required
              },
            ],
            output_variables: ["OutputVariable"],
            role_arn: "RoleArn",
            region: "AWSRegionName",
            namespace: "ActionNamespace",
            timeout_in_minutes: 1,
            environment_variables: [
              {
                name: "EnvironmentVariableName", # required
                value: "EnvironmentVariableValue", # required
                type: "PLAINTEXT", # accepts PLAINTEXT, SECRETS_MANAGER
              },
            ],
          },
        ],
        on_failure: {
          result: "ROLLBACK", # accepts ROLLBACK, FAIL, RETRY, SKIP
          retry_configuration: {
            retry_mode: "FAILED_ACTIONS", # accepts FAILED_ACTIONS, ALL_ACTIONS
          },
          conditions: [
            {
              result: "ROLLBACK", # accepts ROLLBACK, FAIL, RETRY, SKIP
              rules: [
                {
                  name: "RuleName", # required
                  rule_type_id: { # required
                    category: "Rule", # required, accepts Rule
                    owner: "AWS", # accepts AWS
                    provider: "RuleProvider", # required
                    version: "Version",
                  },
                  configuration: {
                    "RuleConfigurationKey" => "RuleConfigurationValue",
                  },
                  commands: ["Command"],
                  input_artifacts: [
                    {
                      name: "ArtifactName", # required
                    },
                  ],
                  role_arn: "RoleArn",
                  region: "AWSRegionName",
                  timeout_in_minutes: 1,
                },
              ],
            },
          ],
        },
        on_success: {
          conditions: [ # required
            {
              result: "ROLLBACK", # accepts ROLLBACK, FAIL, RETRY, SKIP
              rules: [
                {
                  name: "RuleName", # required
                  rule_type_id: { # required
                    category: "Rule", # required, accepts Rule
                    owner: "AWS", # accepts AWS
                    provider: "RuleProvider", # required
                    version: "Version",
                  },
                  configuration: {
                    "RuleConfigurationKey" => "RuleConfigurationValue",
                  },
                  commands: ["Command"],
                  input_artifacts: [
                    {
                      name: "ArtifactName", # required
                    },
                  ],
                  role_arn: "RoleArn",
                  region: "AWSRegionName",
                  timeout_in_minutes: 1,
                },
              ],
            },
          ],
        },
        before_entry: {
          conditions: [ # required
            {
              result: "ROLLBACK", # accepts ROLLBACK, FAIL, RETRY, SKIP
              rules: [
                {
                  name: "RuleName", # required
                  rule_type_id: { # required
                    category: "Rule", # required, accepts Rule
                    owner: "AWS", # accepts AWS
                    provider: "RuleProvider", # required
                    version: "Version",
                  },
                  configuration: {
                    "RuleConfigurationKey" => "RuleConfigurationValue",
                  },
                  commands: ["Command"],
                  input_artifacts: [
                    {
                      name: "ArtifactName", # required
                    },
                  ],
                  role_arn: "RoleArn",
                  region: "AWSRegionName",
                  timeout_in_minutes: 1,
                },
              ],
            },
          ],
        },
      },
    ],
    version: 1,
    execution_mode: "QUEUED", # accepts QUEUED, SUPERSEDED, PARALLEL
    pipeline_type: "V1", # accepts V1, V2
    variables: [
      {
        name: "PipelineVariableName", # required
        default_value: "PipelineVariableValue",
        description: "PipelineVariableDescription",
      },
    ],
    triggers: [
      {
        provider_type: "CodeStarSourceConnection", # required, accepts CodeStarSourceConnection
        git_configuration: { # required
          source_action_name: "ActionName", # required
          push: [
            {
              tags: {
                includes: ["GitTagNamePattern"],
                excludes: ["GitTagNamePattern"],
              },
              branches: {
                includes: ["GitBranchNamePattern"],
                excludes: ["GitBranchNamePattern"],
              },
              file_paths: {
                includes: ["GitFilePathPattern"],
                excludes: ["GitFilePathPattern"],
              },
            },
          ],
          pull_request: [
            {
              events: ["OPEN"], # accepts OPEN, UPDATED, CLOSED
              branches: {
                includes: ["GitBranchNamePattern"],
                excludes: ["GitBranchNamePattern"],
              },
              file_paths: {
                includes: ["GitFilePathPattern"],
                excludes: ["GitFilePathPattern"],
              },
            },
          ],
        },
      },
    ],
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.pipeline.name #=> String
resp.pipeline.role_arn #=> String
resp.pipeline.artifact_store.type #=> String, one of "S3"
resp.pipeline.artifact_store.location #=> String
resp.pipeline.artifact_store.encryption_key.id #=> String
resp.pipeline.artifact_store.encryption_key.type #=> String, one of "KMS"
resp.pipeline.artifact_stores #=> Hash
resp.pipeline.artifact_stores["AWSRegionName"].type #=> String, one of "S3"
resp.pipeline.artifact_stores["AWSRegionName"].location #=> String
resp.pipeline.artifact_stores["AWSRegionName"].encryption_key.id #=> String
resp.pipeline.artifact_stores["AWSRegionName"].encryption_key.type #=> String, one of "KMS"
resp.pipeline.stages #=> Array
resp.pipeline.stages[0].name #=> String
resp.pipeline.stages[0].blockers #=> Array
resp.pipeline.stages[0].blockers[0].name #=> String
resp.pipeline.stages[0].blockers[0].type #=> String, one of "Schedule"
resp.pipeline.stages[0].actions #=> Array
resp.pipeline.stages[0].actions[0].name #=> String
resp.pipeline.stages[0].actions[0].action_type_id.category #=> String, one of "Source", "Build", "Deploy", "Test", "Invoke", "Approval", "Compute"
resp.pipeline.stages[0].actions[0].action_type_id.owner #=> String, one of "AWS", "ThirdParty", "Custom"
resp.pipeline.stages[0].actions[0].action_type_id.provider #=> String
resp.pipeline.stages[0].actions[0].action_type_id.version #=> String
resp.pipeline.stages[0].actions[0].run_order #=> Integer
resp.pipeline.stages[0].actions[0].configuration #=> Hash
resp.pipeline.stages[0].actions[0].configuration["ActionConfigurationKey"] #=> String
resp.pipeline.stages[0].actions[0].commands #=> Array
resp.pipeline.stages[0].actions[0].commands[0] #=> String
resp.pipeline.stages[0].actions[0].output_artifacts #=> Array
resp.pipeline.stages[0].actions[0].output_artifacts[0].name #=> String
resp.pipeline.stages[0].actions[0].output_artifacts[0].files #=> Array
resp.pipeline.stages[0].actions[0].output_artifacts[0].files[0] #=> String
resp.pipeline.stages[0].actions[0].input_artifacts #=> Array
resp.pipeline.stages[0].actions[0].input_artifacts[0].name #=> String
resp.pipeline.stages[0].actions[0].output_variables #=> Array
resp.pipeline.stages[0].actions[0].output_variables[0] #=> String
resp.pipeline.stages[0].actions[0].role_arn #=> String
resp.pipeline.stages[0].actions[0].region #=> String
resp.pipeline.stages[0].actions[0].namespace #=> String
resp.pipeline.stages[0].actions[0].timeout_in_minutes #=> Integer
resp.pipeline.stages[0].actions[0].environment_variables #=> Array
resp.pipeline.stages[0].actions[0].environment_variables[0].name #=> String
resp.pipeline.stages[0].actions[0].environment_variables[0].value #=> String
resp.pipeline.stages[0].actions[0].environment_variables[0].type #=> String, one of "PLAINTEXT", "SECRETS_MANAGER"
resp.pipeline.stages[0].on_failure.result #=> String, one of "ROLLBACK", "FAIL", "RETRY", "SKIP"
resp.pipeline.stages[0].on_failure.retry_configuration.retry_mode #=> String, one of "FAILED_ACTIONS", "ALL_ACTIONS"
resp.pipeline.stages[0].on_failure.conditions #=> Array
resp.pipeline.stages[0].on_failure.conditions[0].result #=> String, one of "ROLLBACK", "FAIL", "RETRY", "SKIP"
resp.pipeline.stages[0].on_failure.conditions[0].rules #=> Array
resp.pipeline.stages[0].on_failure.conditions[0].rules[0].name #=> String
resp.pipeline.stages[0].on_failure.conditions[0].rules[0].rule_type_id.category #=> String, one of "Rule"
resp.pipeline.stages[0].on_failure.conditions[0].rules[0].rule_type_id.owner #=> String, one of "AWS"
resp.pipeline.stages[0].on_failure.conditions[0].rules[0].rule_type_id.provider #=> String
resp.pipeline.stages[0].on_failure.conditions[0].rules[0].rule_type_id.version #=> String
resp.pipeline.stages[0].on_failure.conditions[0].rules[0].configuration #=> Hash
resp.pipeline.stages[0].on_failure.conditions[0].rules[0].configuration["RuleConfigurationKey"] #=> String
resp.pipeline.stages[0].on_failure.conditions[0].rules[0].commands #=> Array
resp.pipeline.stages[0].on_failure.conditions[0].rules[0].commands[0] #=> String
resp.pipeline.stages[0].on_failure.conditions[0].rules[0].input_artifacts #=> Array
resp.pipeline.stages[0].on_failure.conditions[0].rules[0].input_artifacts[0].name #=> String
resp.pipeline.stages[0].on_failure.conditions[0].rules[0].role_arn #=> String
resp.pipeline.stages[0].on_failure.conditions[0].rules[0].region #=> String
resp.pipeline.stages[0].on_failure.conditions[0].rules[0].timeout_in_minutes #=> Integer
resp.pipeline.stages[0].on_success.conditions #=> Array
resp.pipeline.stages[0].on_success.conditions[0].result #=> String, one of "ROLLBACK", "FAIL", "RETRY", "SKIP"
resp.pipeline.stages[0].on_success.conditions[0].rules #=> Array
resp.pipeline.stages[0].on_success.conditions[0].rules[0].name #=> String
resp.pipeline.stages[0].on_success.conditions[0].rules[0].rule_type_id.category #=> String, one of "Rule"
resp.pipeline.stages[0].on_success.conditions[0].rules[0].rule_type_id.owner #=> String, one of "AWS"
resp.pipeline.stages[0].on_success.conditions[0].rules[0].rule_type_id.provider #=> String
resp.pipeline.stages[0].on_success.conditions[0].rules[0].rule_type_id.version #=> String
resp.pipeline.stages[0].on_success.conditions[0].rules[0].configuration #=> Hash
resp.pipeline.stages[0].on_success.conditions[0].rules[0].configuration["RuleConfigurationKey"] #=> String
resp.pipeline.stages[0].on_success.conditions[0].rules[0].commands #=> Array
resp.pipeline.stages[0].on_success.conditions[0].rules[0].commands[0] #=> String
resp.pipeline.stages[0].on_success.conditions[0].rules[0].input_artifacts #=> Array
resp.pipeline.stages[0].on_success.conditions[0].rules[0].input_artifacts[0].name #=> String
resp.pipeline.stages[0].on_success.conditions[0].rules[0].role_arn #=> String
resp.pipeline.stages[0].on_success.conditions[0].rules[0].region #=> String
resp.pipeline.stages[0].on_success.conditions[0].rules[0].timeout_in_minutes #=> Integer
resp.pipeline.stages[0].before_entry.conditions #=> Array
resp.pipeline.stages[0].before_entry.conditions[0].result #=> String, one of "ROLLBACK", "FAIL", "RETRY", "SKIP"
resp.pipeline.stages[0].before_entry.conditions[0].rules #=> Array
resp.pipeline.stages[0].before_entry.conditions[0].rules[0].name #=> String
resp.pipeline.stages[0].before_entry.conditions[0].rules[0].rule_type_id.category #=> String, one of "Rule"
resp.pipeline.stages[0].before_entry.conditions[0].rules[0].rule_type_id.owner #=> String, one of "AWS"
resp.pipeline.stages[0].before_entry.conditions[0].rules[0].rule_type_id.provider #=> String
resp.pipeline.stages[0].before_entry.conditions[0].rules[0].rule_type_id.version #=> String
resp.pipeline.stages[0].before_entry.conditions[0].rules[0].configuration #=> Hash
resp.pipeline.stages[0].before_entry.conditions[0].rules[0].configuration["RuleConfigurationKey"] #=> String
resp.pipeline.stages[0].before_entry.conditions[0].rules[0].commands #=> Array
resp.pipeline.stages[0].before_entry.conditions[0].rules[0].commands[0] #=> String
resp.pipeline.stages[0].before_entry.conditions[0].rules[0].input_artifacts #=> Array
resp.pipeline.stages[0].before_entry.conditions[0].rules[0].input_artifacts[0].name #=> String
resp.pipeline.stages[0].before_entry.conditions[0].rules[0].role_arn #=> String
resp.pipeline.stages[0].before_entry.conditions[0].rules[0].region #=> String
resp.pipeline.stages[0].before_entry.conditions[0].rules[0].timeout_in_minutes #=> Integer
resp.pipeline.version #=> Integer
resp.pipeline.execution_mode #=> String, one of "QUEUED", "SUPERSEDED", "PARALLEL"
resp.pipeline.pipeline_type #=> String, one of "V1", "V2"
resp.pipeline.variables #=> Array
resp.pipeline.variables[0].name #=> String
resp.pipeline.variables[0].default_value #=> String
resp.pipeline.variables[0].description #=> String
resp.pipeline.triggers #=> Array
resp.pipeline.triggers[0].provider_type #=> String, one of "CodeStarSourceConnection"
resp.pipeline.triggers[0].git_configuration.source_action_name #=> String
resp.pipeline.triggers[0].git_configuration.push #=> Array
resp.pipeline.triggers[0].git_configuration.push[0].tags.includes #=> Array
resp.pipeline.triggers[0].git_configuration.push[0].tags.includes[0] #=> String
resp.pipeline.triggers[0].git_configuration.push[0].tags.excludes #=> Array
resp.pipeline.triggers[0].git_configuration.push[0].tags.excludes[0] #=> String
resp.pipeline.triggers[0].git_configuration.push[0].branches.includes #=> Array
resp.pipeline.triggers[0].git_configuration.push[0].branches.includes[0] #=> String
resp.pipeline.triggers[0].git_configuration.push[0].branches.excludes #=> Array
resp.pipeline.triggers[0].git_configuration.push[0].branches.excludes[0] #=> String
resp.pipeline.triggers[0].git_configuration.push[0].file_paths.includes #=> Array
resp.pipeline.triggers[0].git_configuration.push[0].file_paths.includes[0] #=> String
resp.pipeline.triggers[0].git_configuration.push[0].file_paths.excludes #=> Array
resp.pipeline.triggers[0].git_configuration.push[0].file_paths.excludes[0] #=> String
resp.pipeline.triggers[0].git_configuration.pull_request #=> Array
resp.pipeline.triggers[0].git_configuration.pull_request[0].events #=> Array
resp.pipeline.triggers[0].git_configuration.pull_request[0].events[0] #=> String, one of "OPEN", "UPDATED", "CLOSED"
resp.pipeline.triggers[0].git_configuration.pull_request[0].branches.includes #=> Array
resp.pipeline.triggers[0].git_configuration.pull_request[0].branches.includes[0] #=> String
resp.pipeline.triggers[0].git_configuration.pull_request[0].branches.excludes #=> Array
resp.pipeline.triggers[0].git_configuration.pull_request[0].branches.excludes[0] #=> String
resp.pipeline.triggers[0].git_configuration.pull_request[0].file_paths.includes #=> Array
resp.pipeline.triggers[0].git_configuration.pull_request[0].file_paths.includes[0] #=> String
resp.pipeline.triggers[0].git_configuration.pull_request[0].file_paths.excludes #=> Array
resp.pipeline.triggers[0].git_configuration.pull_request[0].file_paths.excludes[0] #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :pipeline (required, Types::PipelineDeclaration) —

    Represents the structure of actions and stages to be performed in the pipeline.

  • :tags (Array<Types::Tag>) —

    The tags for the pipeline.

Returns:

See Also:



1076
1077
1078
1079
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 1076

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

#delete_custom_action_type(params = {}) ⇒ Struct

Marks a custom action as deleted. PollForJobs for the custom action fails after the action is marked for deletion. Used for custom actions only.

To re-create a custom action after it has been deleted you must use a string in the version field that has never been used before. This string can be an incremented version number, for example. To restore a deleted custom action, use a JSON file that is identical to the deleted action, including the original string in the version field.

Examples:

Request syntax with placeholder values


resp = client.delete_custom_action_type({
  category: "Source", # required, accepts Source, Build, Deploy, Test, Invoke, Approval, Compute
  provider: "ActionProvider", # required
  version: "Version", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :category (required, String) —

    The category of the custom action that you want to delete, such as source or deploy.

  • :provider (required, String) —

    The provider of the service used in the custom action, such as CodeDeploy.

  • :version (required, String) —

    The version of the custom action to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1116
1117
1118
1119
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 1116

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

#delete_pipeline(params = {}) ⇒ Struct

Deletes the specified pipeline.

Examples:

Request syntax with placeholder values


resp = client.delete_pipeline({
  name: "PipelineName", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the pipeline to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1138
1139
1140
1141
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 1138

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

#delete_webhook(params = {}) ⇒ Struct

Deletes a previously created webhook by name. Deleting the webhook stops CodePipeline from starting a pipeline every time an external event occurs. The API returns successfully when trying to delete a webhook that is already deleted. If a deleted webhook is re-created by calling PutWebhook with the same name, it will have a different URL.

Examples:

Request syntax with placeholder values


resp = client.delete_webhook({
  name: "WebhookName", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the webhook you want to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1164
1165
1166
1167
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 1164

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

#deregister_webhook_with_third_party(params = {}) ⇒ Struct

Removes the connection between the webhook that was created by CodePipeline and the external tool with events to be detected. Currently supported only for webhooks that target an action type of GitHub.

Examples:

Request syntax with placeholder values


resp = client.deregister_webhook_with_third_party({
  webhook_name: "WebhookName",
})

Parameters:

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

    ({})

Options Hash (params):

  • :webhook_name (String) —

    The name of the webhook you want to deregister.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1189
1190
1191
1192
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 1189

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

#disable_stage_transition(params = {}) ⇒ Struct

Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.

Examples:

Request syntax with placeholder values


resp = client.disable_stage_transition({
  pipeline_name: "PipelineName", # required
  stage_name: "StageName", # required
  transition_type: "Inbound", # required, accepts Inbound, Outbound
  reason: "DisabledReason", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :pipeline_name (required, String) —

    The name of the pipeline in which you want to disable the flow of artifacts from one stage to another.

  • :stage_name (required, String) —

    The name of the stage where you want to disable the inbound or outbound transition of artifacts.

  • :transition_type (required, String) —

    Specifies whether artifacts are prevented from transitioning into the stage and being processed by the actions in that stage (inbound), or prevented from transitioning from the stage after they have been processed by the actions in that stage (outbound).

  • :reason (required, String) —

    The reason given to the user that a stage is disabled, such as waiting for manual approval or manual tests. This message is displayed in the pipeline console UI.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1231
1232
1233
1234
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 1231

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

#enable_stage_transition(params = {}) ⇒ Struct

Enables artifacts in a pipeline to transition to a stage in a pipeline.

Examples:

Request syntax with placeholder values


resp = client.enable_stage_transition({
  pipeline_name: "PipelineName", # required
  stage_name: "StageName", # required
  transition_type: "Inbound", # required, accepts Inbound, Outbound
})

Parameters:

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

    ({})

Options Hash (params):

  • :pipeline_name (required, String) —

    The name of the pipeline in which you want to enable the flow of artifacts from one stage to another.

  • :stage_name (required, String) —

    The name of the stage where you want to enable the transition of artifacts, either into the stage (inbound) or from that stage to the next stage (outbound).

  • :transition_type (required, String) —

    Specifies whether artifacts are allowed to enter the stage and be processed by the actions in that stage (inbound) or whether already processed artifacts are allowed to transition to the next stage (outbound).

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1268
1269
1270
1271
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 1268

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

#get_action_type(params = {}) ⇒ Types::GetActionTypeOutput

Returns information about an action type created for an external provider, where the action is to be used by customers of the external provider. The action can be created with any supported integration model.

Examples:

Request syntax with placeholder values


resp = client.get_action_type({
  category: "Source", # required, accepts Source, Build, Deploy, Test, Invoke, Approval, Compute
  owner: "ActionTypeOwner", # required
  provider: "ActionProvider", # required
  version: "Version", # required
})

Response structure


resp.action_type.description #=> String
resp.action_type.executor.configuration.lambda_executor_configuration.lambda_function_arn #=> String
resp.action_type.executor.configuration.job_worker_executor_configuration.polling_accounts #=> Array
resp.action_type.executor.configuration.job_worker_executor_configuration.polling_accounts[0] #=> String
resp.action_type.executor.configuration.job_worker_executor_configuration.polling_service_principals #=> Array
resp.action_type.executor.configuration.job_worker_executor_configuration.polling_service_principals[0] #=> String
resp.action_type.executor.type #=> String, one of "JobWorker", "Lambda"
resp.action_type.executor.policy_statements_template #=> String
resp.action_type.executor.job_timeout #=> Integer
resp.action_type.id.category #=> String, one of "Source", "Build", "Deploy", "Test", "Invoke", "Approval", "Compute"
resp.action_type.id.owner #=> String
resp.action_type.id.provider #=> String
resp.action_type.id.version #=> String
resp.action_type.input_artifact_details.minimum_count #=> Integer
resp.action_type.input_artifact_details.maximum_count #=> Integer
resp.action_type.output_artifact_details.minimum_count #=> Integer
resp.action_type.output_artifact_details.maximum_count #=> Integer
resp.action_type.permissions.allowed_accounts #=> Array
resp.action_type.permissions.allowed_accounts[0] #=> String
resp.action_type.properties #=> Array
resp.action_type.properties[0].name #=> String
resp.action_type.properties[0].optional #=> Boolean
resp.action_type.properties[0].key #=> Boolean
resp.action_type.properties[0].no_echo #=> Boolean
resp.action_type.properties[0].queryable #=> Boolean
resp.action_type.properties[0].description #=> String
resp.action_type.urls.configuration_url #=> String
resp.action_type.urls.entity_url_template #=> String
resp.action_type.urls.execution_url_template #=> String
resp.action_type.urls.revision_url_template #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :category (required, String) —

    Defines what kind of action can be taken in the stage. The following are the valid values:

    • Source

    • Build

    • Test

    • Deploy

    • Approval

    • Invoke

    • Compute

  • :owner (required, String) —

    The creator of an action type that was created with any supported integration model. There are two valid values: AWS and ThirdParty.

  • :provider (required, String) —

    The provider of the action type being called. The provider name is specified when the action type is created.

  • :version (required, String) —

    A string that describes the action type version.

Returns:

See Also:



1357
1358
1359
1360
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 1357

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

#get_job_details(params = {}) ⇒ Types::GetJobDetailsOutput

Returns information about a job. Used for custom actions only.

When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.

Examples:

Request syntax with placeholder values


resp = client.get_job_details({
  job_id: "JobId", # required
})

Response structure


resp.job_details.id #=> String
resp.job_details.data.action_type_id.category #=> String, one of "Source", "Build", "Deploy", "Test", "Invoke", "Approval", "Compute"
resp.job_details.data.action_type_id.owner #=> String, one of "AWS", "ThirdParty", "Custom"
resp.job_details.data.action_type_id.provider #=> String
resp.job_details.data.action_type_id.version #=> String
resp.job_details.data.action_configuration.configuration #=> Hash
resp.job_details.data.action_configuration.configuration["ActionConfigurationKey"] #=> String
resp.job_details.data.pipeline_context.pipeline_name #=> String
resp.job_details.data.pipeline_context.stage.name #=> String
resp.job_details.data.pipeline_context.action.name #=> String
resp.job_details.data.pipeline_context.action.action_execution_id #=> String
resp.job_details.data.pipeline_context.pipeline_arn #=> String
resp.job_details.data.pipeline_context.pipeline_execution_id #=> String
resp.job_details.data.input_artifacts #=> Array
resp.job_details.data.input_artifacts[0].name #=> String
resp.job_details.data.input_artifacts[0].revision #=> String
resp.job_details.data.input_artifacts[0].location.type #=> String, one of "S3"
resp.job_details.data.input_artifacts[0].location.s3_location.bucket_name #=> String
resp.job_details.data.input_artifacts[0].location.s3_location.object_key #=> String
resp.job_details.data.output_artifacts #=> Array
resp.job_details.data.output_artifacts[0].name #=> String
resp.job_details.data.output_artifacts[0].revision #=> String
resp.job_details.data.output_artifacts[0].location.type #=> String, one of "S3"
resp.job_details.data.output_artifacts[0].location.s3_location.bucket_name #=> String
resp.job_details.data.output_artifacts[0].location.s3_location.object_key #=> String
resp.job_details.data.artifact_credentials.access_key_id #=> String
resp.job_details.data.artifact_credentials.secret_access_key #=> String
resp.job_details.data.artifact_credentials.session_token #=> String
resp.job_details.data.continuation_token #=> String
resp.job_details.data.encryption_key.id #=> String
resp.job_details.data.encryption_key.type #=> String, one of "KMS"
resp.job_details. #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The unique system-generated ID for the job.

Returns:

See Also:



1422
1423
1424
1425
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 1422

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

#get_pipeline(params = {}) ⇒ Types::GetPipelineOutput

Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with UpdatePipeline.

Examples:

Request syntax with placeholder values


resp = client.get_pipeline({
  name: "PipelineName", # required
  version: 1,
})

Response structure


resp.pipeline.name #=> String
resp.pipeline.role_arn #=> String
resp.pipeline.artifact_store.type #=> String, one of "S3"
resp.pipeline.artifact_store.location #=> String
resp.pipeline.artifact_store.encryption_key.id #=> String
resp.pipeline.artifact_store.encryption_key.type #=> String, one of "KMS"
resp.pipeline.artifact_stores #=> Hash
resp.pipeline.artifact_stores["AWSRegionName"].type #=> String, one of "S3"
resp.pipeline.artifact_stores["AWSRegionName"].location #=> String
resp.pipeline.artifact_stores["AWSRegionName"].encryption_key.id #=> String
resp.pipeline.artifact_stores["AWSRegionName"].encryption_key.type #=> String, one of "KMS"
resp.pipeline.stages #=> Array
resp.pipeline.stages[0].name #=> String
resp.pipeline.stages[0].blockers #=> Array
resp.pipeline.stages[0].blockers[0].name #=> String
resp.pipeline.stages[0].blockers[0].type #=> String, one of "Schedule"
resp.pipeline.stages[0].actions #=> Array
resp.pipeline.stages[0].actions[0].name #=> String
resp.pipeline.stages[0].actions[0].action_type_id.category #=> String, one of "Source", "Build", "Deploy", "Test", "Invoke", "Approval", "Compute"
resp.pipeline.stages[0].actions[0].action_type_id.owner #=> String, one of "AWS", "ThirdParty", "Custom"
resp.pipeline.stages[0].actions[0].action_type_id.provider #=> String
resp.pipeline.stages[0].actions[0].action_type_id.version #=> String
resp.pipeline.stages[0].actions[0].run_order #=> Integer
resp.pipeline.stages[0].actions[0].configuration #=> Hash
resp.pipeline.stages[0].actions[0].configuration["ActionConfigurationKey"] #=> String
resp.pipeline.stages[0].actions[0].commands #=> Array
resp.pipeline.stages[0].actions[0].commands[0] #=> String
resp.pipeline.stages[0].actions[0].output_artifacts #=> Array
resp.pipeline.stages[0].actions[0].output_artifacts[0].name #=> String
resp.pipeline.stages[0].actions[0].output_artifacts[0].files #=> Array
resp.pipeline.stages[0].actions[0].output_artifacts[0].files[0] #=> String
resp.pipeline.stages[0].actions[0].input_artifacts #=> Array
resp.pipeline.stages[0].actions[0].input_artifacts[0].name #=> String
resp.pipeline.stages[0].actions[0].output_variables #=> Array
resp.pipeline.stages[0].actions[0].output_variables[0] #=> String
resp.pipeline.stages[0].actions[0].role_arn #=> String
resp.pipeline.stages[0].actions[0].region #=> String
resp.pipeline.stages[0].actions[0].namespace #=> String
resp.pipeline.stages[0].actions[0].timeout_in_minutes #=> Integer
resp.pipeline.stages[0].actions[0].environment_variables #=> Array
resp.pipeline.stages[0].actions[0].environment_variables[0].name #=> String
resp.pipeline.stages[0].actions[0].environment_variables[0].value #=> String
resp.pipeline.stages[0].actions[0].environment_variables[0].type #=> String, one of "PLAINTEXT", "SECRETS_MANAGER"
resp.pipeline.stages[0].on_failure.result #=> String, one of "ROLLBACK", "FAIL", "RETRY", "SKIP"
resp.pipeline.stages[0].on_failure.retry_configuration.retry_mode #=> String, one of "FAILED_ACTIONS", "ALL_ACTIONS"
resp.pipeline.stages[0].on_failure.conditions #=> Array
resp.pipeline.stages[0].on_failure.conditions[0].result #=> String, one of "ROLLBACK", "FAIL", "RETRY", "SKIP"
resp.pipeline.stages[0].on_failure.conditions[0].rules #=> Array
resp.pipeline.stages[0].on_failure.conditions[0].rules[0].name #=> String
resp.pipeline.stages[0].on_failure.conditions[0].rules[0].rule_type_id.category #=> String, one of "Rule"
resp.pipeline.stages[0].on_failure.conditions[0].rules[0].rule_type_id.owner #=> String, one of "AWS"
resp.pipeline.stages[0].on_failure.conditions[0].rules[0].rule_type_id.provider #=> String
resp.pipeline.stages[0].on_failure.conditions[0].rules[0].rule_type_id.version #=> String
resp.pipeline.stages[0].on_failure.conditions[0].rules[0].configuration #=> Hash
resp.pipeline.stages[0].on_failure.conditions[0].rules[0].configuration["RuleConfigurationKey"] #=> String
resp.pipeline.stages[0].on_failure.conditions[0].rules[0].commands #=> Array
resp.pipeline.stages[0].on_failure.conditions[0].rules[0].commands[0] #=> String
resp.pipeline.stages[0].on_failure.conditions[0].rules[0].input_artifacts #=> Array
resp.pipeline.stages[0].on_failure.conditions[0].rules[0].input_artifacts[0].name #=> String
resp.pipeline.stages[0].on_failure.conditions[0].rules[0].role_arn #=> String
resp.pipeline.stages[0].on_failure.conditions[0].rules[0].region #=> String
resp.pipeline.stages[0].on_failure.conditions[0].rules[0].timeout_in_minutes #=> Integer
resp.pipeline.stages[0].on_success.conditions #=> Array
resp.pipeline.stages[0].on_success.conditions[0].result #=> String, one of "ROLLBACK", "FAIL", "RETRY", "SKIP"
resp.pipeline.stages[0].on_success.conditions[0].rules #=> Array
resp.pipeline.stages[0].on_success.conditions[0].rules[0].name #=> String
resp.pipeline.stages[0].on_success.conditions[0].rules[0].rule_type_id.category #=> String, one of "Rule"
resp.pipeline.stages[0].on_success.conditions[0].rules[0].rule_type_id.owner #=> String, one of "AWS"
resp.pipeline.stages[0].on_success.conditions[0].rules[0].rule_type_id.provider #=> String
resp.pipeline.stages[0].on_success.conditions[0].rules[0].rule_type_id.version #=> String
resp.pipeline.stages[0].on_success.conditions[0].rules[0].configuration #=> Hash
resp.pipeline.stages[0].on_success.conditions[0].rules[0].configuration["RuleConfigurationKey"] #=> String
resp.pipeline.stages[0].on_success.conditions[0].rules[0].commands #=> Array
resp.pipeline.stages[0].on_success.conditions[0].rules[0].commands[0] #=> String
resp.pipeline.stages[0].on_success.conditions[0].rules[0].input_artifacts #=> Array
resp.pipeline.stages[0].on_success.conditions[0].rules[0].input_artifacts[0].name #=> String
resp.pipeline.stages[0].on_success.conditions[0].rules[0].role_arn #=> String
resp.pipeline.stages[0].on_success.conditions[0].rules[0].region #=> String
resp.pipeline.stages[0].on_success.conditions[0].rules[0].timeout_in_minutes #=> Integer
resp.pipeline.stages[0].before_entry.conditions #=> Array
resp.pipeline.stages[0].before_entry.conditions[0].result #=> String, one of "ROLLBACK", "FAIL", "RETRY", "SKIP"
resp.pipeline.stages[0].before_entry.conditions[0].rules #=> Array
resp.pipeline.stages[0].before_entry.conditions[0].rules[0].name #=> String
resp.pipeline.stages[0].before_entry.conditions[0].rules[0].rule_type_id.category #=> String, one of "Rule"
resp.pipeline.stages[0].before_entry.conditions[0].rules[0].rule_type_id.owner #=> String, one of "AWS"
resp.pipeline.stages[0].before_entry.conditions[0].rules[0].rule_type_id.provider #=> String
resp.pipeline.stages[0].before_entry.conditions[0].rules[0].rule_type_id.version #=> String
resp.pipeline.stages[0].before_entry.conditions[0].rules[0].configuration #=> Hash
resp.pipeline.stages[0].before_entry.conditions[0].rules[0].configuration["RuleConfigurationKey"] #=> String
resp.pipeline.stages[0].before_entry.conditions[0].rules[0].commands #=> Array
resp.pipeline.stages[0].before_entry.conditions[0].rules[0].commands[0] #=> String
resp.pipeline.stages[0].before_entry.conditions[0].rules[0].input_artifacts #=> Array
resp.pipeline.stages[0].before_entry.conditions[0].rules[0].input_artifacts[0].name #=> String
resp.pipeline.stages[0].before_entry.conditions[0].rules[0].role_arn #=> String
resp.pipeline.stages[0].before_entry.conditions[0].rules[0].region #=> String
resp.pipeline.stages[0].before_entry.conditions[0].rules[0].timeout_in_minutes #=> Integer
resp.pipeline.version #=> Integer
resp.pipeline.execution_mode #=> String, one of "QUEUED", "SUPERSEDED", "PARALLEL"
resp.pipeline.pipeline_type #=> String, one of "V1", "V2"
resp.pipeline.variables #=> Array
resp.pipeline.variables[0].name #=> String
resp.pipeline.variables[0].default_value #=> String
resp.pipeline.variables[0].description #=> String
resp.pipeline.triggers #=> Array
resp.pipeline.triggers[0].provider_type #=> String, one of "CodeStarSourceConnection"
resp.pipeline.triggers[0].git_configuration.source_action_name #=> String
resp.pipeline.triggers[0].git_configuration.push #=> Array
resp.pipeline.triggers[0].git_configuration.push[0].tags.includes #=> Array
resp.pipeline.triggers[0].git_configuration.push[0].tags.includes[0] #=> String
resp.pipeline.triggers[0].git_configuration.push[0].tags.excludes #=> Array
resp.pipeline.triggers[0].git_configuration.push[0].tags.excludes[0] #=> String
resp.pipeline.triggers[0].git_configuration.push[0].branches.includes #=> Array
resp.pipeline.triggers[0].git_configuration.push[0].branches.includes[0] #=> String
resp.pipeline.triggers[0].git_configuration.push[0].branches.excludes #=> Array
resp.pipeline.triggers[0].git_configuration.push[0].branches.excludes[0] #=> String
resp.pipeline.triggers[0].git_configuration.push[0].file_paths.includes #=> Array
resp.pipeline.triggers[0].git_configuration.push[0].file_paths.includes[0] #=> String
resp.pipeline.triggers[0].git_configuration.push[0].file_paths.excludes #=> Array
resp.pipeline.triggers[0].git_configuration.push[0].file_paths.excludes[0] #=> String
resp.pipeline.triggers[0].git_configuration.pull_request #=> Array
resp.pipeline.triggers[0].git_configuration.pull_request[0].events #=> Array
resp.pipeline.triggers[0].git_configuration.pull_request[0].events[0] #=> String, one of "OPEN", "UPDATED", "CLOSED"
resp.pipeline.triggers[0].git_configuration.pull_request[0].branches.includes #=> Array
resp.pipeline.triggers[0].git_configuration.pull_request[0].branches.includes[0] #=> String
resp.pipeline.triggers[0].git_configuration.pull_request[0].branches.excludes #=> Array
resp.pipeline.triggers[0].git_configuration.pull_request[0].branches.excludes[0] #=> String
resp.pipeline.triggers[0].git_configuration.pull_request[0].file_paths.includes #=> Array
resp.pipeline.triggers[0].git_configuration.pull_request[0].file_paths.includes[0] #=> String
resp.pipeline.triggers[0].git_configuration.pull_request[0].file_paths.excludes #=> Array
resp.pipeline.triggers[0].git_configuration.pull_request[0].file_paths.excludes[0] #=> String
resp.metadata.pipeline_arn #=> String
resp.metadata.created #=> Time
resp.metadata.updated #=> Time
resp.metadata.polling_disabled_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the pipeline for which you want to get information. Pipeline names must be unique in an Amazon Web Services account.

  • :version (Integer) —

    The version number of the pipeline. If you do not specify a version, defaults to the current version.

Returns:

See Also:



1593
1594
1595
1596
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 1593

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

#get_pipeline_execution(params = {}) ⇒ Types::GetPipelineExecutionOutput

Returns information about an execution of a pipeline, including details about artifacts, the pipeline execution ID, and the name, version, and status of the pipeline.

Examples:

Request syntax with placeholder values


resp = client.get_pipeline_execution({
  pipeline_name: "PipelineName", # required
  pipeline_execution_id: "PipelineExecutionId", # required
})

Response structure


resp.pipeline_execution.pipeline_name #=> String
resp.pipeline_execution.pipeline_version #=> Integer
resp.pipeline_execution.pipeline_execution_id #=> String
resp.pipeline_execution.status #=> String, one of "Cancelled", "InProgress", "Stopped", "Stopping", "Succeeded", "Superseded", "Failed"
resp.pipeline_execution.status_summary #=> String
resp.pipeline_execution.artifact_revisions #=> Array
resp.pipeline_execution.artifact_revisions[0].name #=> String
resp.pipeline_execution.artifact_revisions[0].revision_id #=> String
resp.pipeline_execution.artifact_revisions[0].revision_change_identifier #=> String
resp.pipeline_execution.artifact_revisions[0].revision_summary #=> String
resp.pipeline_execution.artifact_revisions[0].created #=> Time
resp.pipeline_execution.artifact_revisions[0].revision_url #=> String
resp.pipeline_execution.variables #=> Array
resp.pipeline_execution.variables[0].name #=> String
resp.pipeline_execution.variables[0].resolved_value #=> String
resp.pipeline_execution.trigger.trigger_type #=> String, one of "CreatePipeline", "StartPipelineExecution", "PollForSourceChanges", "Webhook", "CloudWatchEvent", "PutActionRevision", "WebhookV2", "ManualRollback", "AutomatedRollback"
resp.pipeline_execution.trigger.trigger_detail #=> String
resp.pipeline_execution.execution_mode #=> String, one of "QUEUED", "SUPERSEDED", "PARALLEL"
resp.pipeline_execution.execution_type #=> String, one of "STANDARD", "ROLLBACK"
resp.pipeline_execution.rollback_metadata.rollback_target_pipeline_execution_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :pipeline_name (required, String) —

    The name of the pipeline about which you want to get execution details.

  • :pipeline_execution_id (required, String) —

    The ID of the pipeline execution about which you want to get execution details.

Returns:

See Also:



1648
1649
1650
1651
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 1648

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

#get_pipeline_state(params = {}) ⇒ Types::GetPipelineStateOutput

Returns information about the state of a pipeline, including the stages and actions.

Values returned in the revisionId and revisionUrl fields indicate the source revision information, such as the commit ID, for the current state.

Examples:

Request syntax with placeholder values


resp = client.get_pipeline_state({
  name: "PipelineName", # required
})

Response structure


resp.pipeline_name #=> String
resp.pipeline_version #=> Integer
resp.stage_states #=> Array
resp.stage_states[0].stage_name #=> String
resp.stage_states[0].inbound_execution.pipeline_execution_id #=> String
resp.stage_states[0].inbound_execution.status #=> String, one of "Cancelled", "InProgress", "Failed", "Stopped", "Stopping", "Succeeded", "Skipped"
resp.stage_states[0].inbound_execution.type #=> String, one of "STANDARD", "ROLLBACK"
resp.stage_states[0].inbound_executions #=> Array
resp.stage_states[0].inbound_executions[0].pipeline_execution_id #=> String
resp.stage_states[0].inbound_executions[0].status #=> String, one of "Cancelled", "InProgress", "Failed", "Stopped", "Stopping", "Succeeded", "Skipped"
resp.stage_states[0].inbound_executions[0].type #=> String, one of "STANDARD", "ROLLBACK"
resp.stage_states[0].inbound_transition_state.enabled #=> Boolean
resp.stage_states[0].inbound_transition_state.last_changed_by #=> String
resp.stage_states[0].inbound_transition_state.last_changed_at #=> Time
resp.stage_states[0].inbound_transition_state.disabled_reason #=> String
resp.stage_states[0].action_states #=> Array
resp.stage_states[0].action_states[0].action_name #=> String
resp.stage_states[0].action_states[0].current_revision.revision_id #=> String
resp.stage_states[0].action_states[0].current_revision.revision_change_id #=> String
resp.stage_states[0].action_states[0].current_revision.created #=> Time
resp.stage_states[0].action_states[0].latest_execution.action_execution_id #=> String
resp.stage_states[0].action_states[0].latest_execution.status #=> String, one of "InProgress", "Abandoned", "Succeeded", "Failed"
resp.stage_states[0].action_states[0].latest_execution.summary #=> String
resp.stage_states[0].action_states[0].latest_execution.last_status_change #=> Time
resp.stage_states[0].action_states[0].latest_execution.token #=> String
resp.stage_states[0].action_states[0].latest_execution.last_updated_by #=> String
resp.stage_states[0].action_states[0].latest_execution.external_execution_id #=> String
resp.stage_states[0].action_states[0].latest_execution.external_execution_url #=> String
resp.stage_states[0].action_states[0].latest_execution.percent_complete #=> Integer
resp.stage_states[0].action_states[0].latest_execution.error_details.code #=> String
resp.stage_states[0].action_states[0].latest_execution.error_details.message #=> String
resp.stage_states[0].action_states[0].latest_execution.log_stream_arn #=> String
resp.stage_states[0].action_states[0].entity_url #=> String
resp.stage_states[0].action_states[0].revision_url #=> String
resp.stage_states[0].latest_execution.pipeline_execution_id #=> String
resp.stage_states[0].latest_execution.status #=> String, one of "Cancelled", "InProgress", "Failed", "Stopped", "Stopping", "Succeeded", "Skipped"
resp.stage_states[0].latest_execution.type #=> String, one of "STANDARD", "ROLLBACK"
resp.stage_states[0].before_entry_condition_state.latest_execution.status #=> String, one of "InProgress", "Failed", "Errored", "Succeeded", "Cancelled", "Abandoned", "Overridden"
resp.stage_states[0].before_entry_condition_state.latest_execution.summary #=> String
resp.stage_states[0].before_entry_condition_state.condition_states #=> Array
resp.stage_states[0].before_entry_condition_state.condition_states[0].latest_execution.status #=> String, one of "InProgress", "Failed", "Errored", "Succeeded", "Cancelled", "Abandoned", "Overridden"
resp.stage_states[0].before_entry_condition_state.condition_states[0].latest_execution.summary #=> String
resp.stage_states[0].before_entry_condition_state.condition_states[0].latest_execution.last_status_change #=> Time
resp.stage_states[0].before_entry_condition_state.condition_states[0].rule_states #=> Array
resp.stage_states[0].before_entry_condition_state.condition_states[0].rule_states[0].rule_name #=> String
resp.stage_states[0].before_entry_condition_state.condition_states[0].rule_states[0].current_revision.revision_id #=> String
resp.stage_states[0].before_entry_condition_state.condition_states[0].rule_states[0].current_revision.revision_change_id #=> String
resp.stage_states[0].before_entry_condition_state.condition_states[0].rule_states[0].current_revision.created #=> Time
resp.stage_states[0].before_entry_condition_state.condition_states[0].rule_states[0].latest_execution.rule_execution_id #=> String
resp.stage_states[0].before_entry_condition_state.condition_states[0].rule_states[0].latest_execution.status #=> String, one of "InProgress", "Abandoned", "Succeeded", "Failed"
resp.stage_states[0].before_entry_condition_state.condition_states[0].rule_states[0].latest_execution.summary #=> String
resp.stage_states[0].before_entry_condition_state.condition_states[0].rule_states[0].latest_execution.last_status_change #=> Time
resp.stage_states[0].before_entry_condition_state.condition_states[0].rule_states[0].latest_execution.token #=> String
resp.stage_states[0].before_entry_condition_state.condition_states[0].rule_states[0].latest_execution.last_updated_by #=> String
resp.stage_states[0].before_entry_condition_state.condition_states[0].rule_states[0].latest_execution.external_execution_id #=> String
resp.stage_states[0].before_entry_condition_state.condition_states[0].rule_states[0].latest_execution.external_execution_url #=> String
resp.stage_states[0].before_entry_condition_state.condition_states[0].rule_states[0].latest_execution.error_details.code #=> String
resp.stage_states[0].before_entry_condition_state.condition_states[0].rule_states[0].latest_execution.error_details.message #=> String
resp.stage_states[0].before_entry_condition_state.condition_states[0].rule_states[0].entity_url #=> String
resp.stage_states[0].before_entry_condition_state.condition_states[0].rule_states[0].revision_url #=> String
resp.stage_states[0].on_success_condition_state.latest_execution.status #=> String, one of "InProgress", "Failed", "Errored", "Succeeded", "Cancelled", "Abandoned", "Overridden"
resp.stage_states[0].on_success_condition_state.latest_execution.summary #=> String
resp.stage_states[0].on_success_condition_state.condition_states #=> Array
resp.stage_states[0].on_success_condition_state.condition_states[0].latest_execution.status #=> String, one of "InProgress", "Failed", "Errored", "Succeeded", "Cancelled", "Abandoned", "Overridden"
resp.stage_states[0].on_success_condition_state.condition_states[0].latest_execution.summary #=> String
resp.stage_states[0].on_success_condition_state.condition_states[0].latest_execution.last_status_change #=> Time
resp.stage_states[0].on_success_condition_state.condition_states[0].rule_states #=> Array
resp.stage_states[0].on_success_condition_state.condition_states[0].rule_states[0].rule_name #=> String
resp.stage_states[0].on_success_condition_state.condition_states[0].rule_states[0].current_revision.revision_id #=> String
resp.stage_states[0].on_success_condition_state.condition_states[0].rule_states[0].current_revision.revision_change_id #=> String
resp.stage_states[0].on_success_condition_state.condition_states[0].rule_states[0].current_revision.created #=> Time
resp.stage_states[0].on_success_condition_state.condition_states[0].rule_states[0].latest_execution.rule_execution_id #=> String
resp.stage_states[0].on_success_condition_state.condition_states[0].rule_states[0].latest_execution.status #=> String, one of "InProgress", "Abandoned", "Succeeded", "Failed"
resp.stage_states[0].on_success_condition_state.condition_states[0].rule_states[0].latest_execution.summary #=> String
resp.stage_states[0].on_success_condition_state.condition_states[0].rule_states[0].latest_execution.last_status_change #=> Time
resp.stage_states[0].on_success_condition_state.condition_states[0].rule_states[0].latest_execution.token #=> String
resp.stage_states[0].on_success_condition_state.condition_states[0].rule_states[0].latest_execution.last_updated_by #=> String
resp.stage_states[0].on_success_condition_state.condition_states[0].rule_states[0].latest_execution.external_execution_id #=> String
resp.stage_states[0].on_success_condition_state.condition_states[0].rule_states[0].latest_execution.external_execution_url #=> String
resp.stage_states[0].on_success_condition_state.condition_states[0].rule_states[0].latest_execution.error_details.code #=> String
resp.stage_states[0].on_success_condition_state.condition_states[0].rule_states[0].latest_execution.error_details.message #=> String
resp.stage_states[0].on_success_condition_state.condition_states[0].rule_states[0].entity_url #=> String
resp.stage_states[0].on_success_condition_state.condition_states[0].rule_states[0].revision_url #=> String
resp.stage_states[0].on_failure_condition_state.latest_execution.status #=> String, one of "InProgress", "Failed", "Errored", "Succeeded", "Cancelled", "Abandoned", "Overridden"
resp.stage_states[0].on_failure_condition_state.latest_execution.summary #=> String
resp.stage_states[0].on_failure_condition_state.condition_states #=> Array
resp.stage_states[0].on_failure_condition_state.condition_states[0].latest_execution.status #=> String, one of "InProgress", "Failed", "Errored", "Succeeded", "Cancelled", "Abandoned", "Overridden"
resp.stage_states[0].on_failure_condition_state.condition_states[0].latest_execution.summary #=> String
resp.stage_states[0].on_failure_condition_state.condition_states[0].latest_execution.last_status_change #=> Time
resp.stage_states[0].on_failure_condition_state.condition_states[0].rule_states #=> Array
resp.stage_states[0].on_failure_condition_state.condition_states[0].rule_states[0].rule_name #=> String
resp.stage_states[0].on_failure_condition_state.condition_states[0].rule_states[0].current_revision.revision_id #=> String
resp.stage_states[0].on_failure_condition_state.condition_states[0].rule_states[0].current_revision.revision_change_id #=> String
resp.stage_states[0].on_failure_condition_state.condition_states[0].rule_states[0].current_revision.created #=> Time
resp.stage_states[0].on_failure_condition_state.condition_states[0].rule_states[0].latest_execution.rule_execution_id #=> String
resp.stage_states[0].on_failure_condition_state.condition_states[0].rule_states[0].latest_execution.status #=> String, one of "InProgress", "Abandoned", "Succeeded", "Failed"
resp.stage_states[0].on_failure_condition_state.condition_states[0].rule_states[0].latest_execution.summary #=> String
resp.stage_states[0].on_failure_condition_state.condition_states[0].rule_states[0].latest_execution.last_status_change #=> Time
resp.stage_states[0].on_failure_condition_state.condition_states[0].rule_states[0].latest_execution.token #=> String
resp.stage_states[0].on_failure_condition_state.condition_states[0].rule_states[0].latest_execution.last_updated_by #=> String
resp.stage_states[0].on_failure_condition_state.condition_states[0].rule_states[0].latest_execution.external_execution_id #=> String
resp.stage_states[0].on_failure_condition_state.condition_states[0].rule_states[0].latest_execution.external_execution_url #=> String
resp.stage_states[0].on_failure_condition_state.condition_states[0].rule_states[0].latest_execution.error_details.code #=> String
resp.stage_states[0].on_failure_condition_state.condition_states[0].rule_states[0].latest_execution.error_details.message #=> String
resp.stage_states[0].on_failure_condition_state.condition_states[0].rule_states[0].entity_url #=> String
resp.stage_states[0].on_failure_condition_state.condition_states[0].rule_states[0].revision_url #=> String
resp.stage_states[0].retry_stage_metadata.auto_stage_retry_attempt #=> Integer
resp.stage_states[0].retry_stage_metadata.manual_stage_retry_attempt #=> Integer
resp.stage_states[0].retry_stage_metadata.latest_retry_trigger #=> String, one of "AutomatedStageRetry", "ManualStageRetry"
resp.created #=> Time
resp.updated #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the pipeline about which you want to get information.

Returns:

See Also:



1797
1798
1799
1800
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 1797

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

#get_third_party_job_details(params = {}) ⇒ Types::GetThirdPartyJobDetailsOutput

Requests the details of a job for a third party action. Used for partner actions only.

When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.

Examples:

Request syntax with placeholder values


resp = client.get_third_party_job_details({
  job_id: "ThirdPartyJobId", # required
  client_token: "ClientToken", # required
})

Response structure


resp.job_details.id #=> String
resp.job_details.data.action_type_id.category #=> String, one of "Source", "Build", "Deploy", "Test", "Invoke", "Approval", "Compute"
resp.job_details.data.action_type_id.owner #=> String, one of "AWS", "ThirdParty", "Custom"
resp.job_details.data.action_type_id.provider #=> String
resp.job_details.data.action_type_id.version #=> String
resp.job_details.data.action_configuration.configuration #=> Hash
resp.job_details.data.action_configuration.configuration["ActionConfigurationKey"] #=> String
resp.job_details.data.pipeline_context.pipeline_name #=> String
resp.job_details.data.pipeline_context.stage.name #=> String
resp.job_details.data.pipeline_context.action.name #=> String
resp.job_details.data.pipeline_context.action.action_execution_id #=> String
resp.job_details.data.pipeline_context.pipeline_arn #=> String
resp.job_details.data.pipeline_context.pipeline_execution_id #=> String
resp.job_details.data.input_artifacts #=> Array
resp.job_details.data.input_artifacts[0].name #=> String
resp.job_details.data.input_artifacts[0].revision #=> String
resp.job_details.data.input_artifacts[0].location.type #=> String, one of "S3"
resp.job_details.data.input_artifacts[0].location.s3_location.bucket_name #=> String
resp.job_details.data.input_artifacts[0].location.s3_location.object_key #=> String
resp.job_details.data.output_artifacts #=> Array
resp.job_details.data.output_artifacts[0].name #=> String
resp.job_details.data.output_artifacts[0].revision #=> String
resp.job_details.data.output_artifacts[0].location.type #=> String, one of "S3"
resp.job_details.data.output_artifacts[0].location.s3_location.bucket_name #=> String
resp.job_details.data.output_artifacts[0].location.s3_location.object_key #=> String
resp.job_details.data.artifact_credentials.access_key_id #=> String
resp.job_details.data.artifact_credentials.secret_access_key #=> String
resp.job_details.data.artifact_credentials.session_token #=> String
resp.job_details.data.continuation_token #=> String
resp.job_details.data.encryption_key.id #=> String
resp.job_details.data.encryption_key.type #=> String, one of "KMS"
resp.job_details.nonce #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The unique system-generated ID used for identifying the job.

  • :client_token (required, String) —

    The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.

Returns:

See Also:



1869
1870
1871
1872
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 1869

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

#list_action_executions(params = {}) ⇒ Types::ListActionExecutionsOutput

Lists the action executions that have occurred in a pipeline.

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

Examples:

Request syntax with placeholder values


resp = client.list_action_executions({
  pipeline_name: "PipelineName", # required
  filter: {
    pipeline_execution_id: "PipelineExecutionId",
    latest_in_pipeline_execution: {
      pipeline_execution_id: "PipelineExecutionId", # required
      start_time_range: "Latest", # required, accepts Latest, All
    },
  },
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.action_execution_details #=> Array
resp.action_execution_details[0].pipeline_execution_id #=> String
resp.action_execution_details[0].action_execution_id #=> String
resp.action_execution_details[0].pipeline_version #=> Integer
resp.action_execution_details[0].stage_name #=> String
resp.action_execution_details[0].action_name #=> String
resp.action_execution_details[0].start_time #=> Time
resp.action_execution_details[0].last_update_time #=> Time
resp.action_execution_details[0].updated_by #=> String
resp.action_execution_details[0].status #=> String, one of "InProgress", "Abandoned", "Succeeded", "Failed"
resp.action_execution_details[0].input.action_type_id.category #=> String, one of "Source", "Build", "Deploy", "Test", "Invoke", "Approval", "Compute"
resp.action_execution_details[0].input.action_type_id.owner #=> String, one of "AWS", "ThirdParty", "Custom"
resp.action_execution_details[0].input.action_type_id.provider #=> String
resp.action_execution_details[0].input.action_type_id.version #=> String
resp.action_execution_details[0].input.configuration #=> Hash
resp.action_execution_details[0].input.configuration["ActionConfigurationKey"] #=> String
resp.action_execution_details[0].input.resolved_configuration #=> Hash
resp.action_execution_details[0].input.resolved_configuration["String"] #=> String
resp.action_execution_details[0].input.role_arn #=> String
resp.action_execution_details[0].input.region #=> String
resp.action_execution_details[0].input.input_artifacts #=> Array
resp.action_execution_details[0].input.input_artifacts[0].name #=> String
resp.action_execution_details[0].input.input_artifacts[0].s3location.bucket #=> String
resp.action_execution_details[0].input.input_artifacts[0].s3location.key #=> String
resp.action_execution_details[0].input.namespace #=> String
resp.action_execution_details[0].output.output_artifacts #=> Array
resp.action_execution_details[0].output.output_artifacts[0].name #=> String
resp.action_execution_details[0].output.output_artifacts[0].s3location.bucket #=> String
resp.action_execution_details[0].output.output_artifacts[0].s3location.key #=> String
resp.action_execution_details[0].output.execution_result.external_execution_id #=> String
resp.action_execution_details[0].output.execution_result.external_execution_summary #=> String
resp.action_execution_details[0].output.execution_result.external_execution_url #=> String
resp.action_execution_details[0].output.execution_result.error_details.code #=> String
resp.action_execution_details[0].output.execution_result.error_details.message #=> String
resp.action_execution_details[0].output.execution_result.log_stream_arn #=> String
resp.action_execution_details[0].output.output_variables #=> Hash
resp.action_execution_details[0].output.output_variables["OutputVariablesKey"] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :pipeline_name (required, String) —

    The name of the pipeline for which you want to list action execution history.

  • :filter (Types::ActionExecutionFilter) —

    Input information used to filter action execution history.

  • :max_results (Integer) —

    The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value. Action execution history is retained for up to 12 months, based on action execution start times. Default value is 100.

  • :next_token (String) —

    The token that was returned from the previous ListActionExecutions call, which can be used to return the next set of action executions in the list.

Returns:

See Also:



1961
1962
1963
1964
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 1961

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

#list_action_types(params = {}) ⇒ Types::ListActionTypesOutput

Gets a summary of all CodePipeline action types associated with your account.

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

Examples:

Request syntax with placeholder values


resp = client.list_action_types({
  action_owner_filter: "AWS", # accepts AWS, ThirdParty, Custom
  next_token: "NextToken",
  region_filter: "AWSRegionName",
})

Response structure


resp.action_types #=> Array
resp.action_types[0].id.category #=> String, one of "Source", "Build", "Deploy", "Test", "Invoke", "Approval", "Compute"
resp.action_types[0].id.owner #=> String, one of "AWS", "ThirdParty", "Custom"
resp.action_types[0].id.provider #=> String
resp.action_types[0].id.version #=> String
resp.action_types[0].settings.third_party_configuration_url #=> String
resp.action_types[0].settings.entity_url_template #=> String
resp.action_types[0].settings.execution_url_template #=> String
resp.action_types[0].settings.revision_url_template #=> String
resp.action_types[0].action_configuration_properties #=> Array
resp.action_types[0].action_configuration_properties[0].name #=> String
resp.action_types[0].action_configuration_properties[0].required #=> Boolean
resp.action_types[0].action_configuration_properties[0].key #=> Boolean
resp.action_types[0].action_configuration_properties[0].secret #=> Boolean
resp.action_types[0].action_configuration_properties[0].queryable #=> Boolean
resp.action_types[0].action_configuration_properties[0].description #=> String
resp.action_types[0].action_configuration_properties[0].type #=> String, one of "String", "Number", "Boolean"
resp.action_types[0].input_artifact_details.minimum_count #=> Integer
resp.action_types[0].input_artifact_details.maximum_count #=> Integer
resp.action_types[0].output_artifact_details.minimum_count #=> Integer
resp.action_types[0].output_artifact_details.maximum_count #=> Integer
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :action_owner_filter (String) —

    Filters the list of action types to those created by a specified entity.

  • :next_token (String) —

    An identifier that was returned from the previous list action types call, which can be used to return the next set of action types in the list.

  • :region_filter (String) —

    The Region to filter on for the list of action types.

Returns:

See Also:



2025
2026
2027
2028
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 2025

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

#list_deploy_action_execution_targets(params = {}) ⇒ Types::ListDeployActionExecutionTargetsOutput

Lists the targets for the deploy action.

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

Examples:

Request syntax with placeholder values


resp = client.list_deploy_action_execution_targets({
  pipeline_name: "PipelineName",
  action_execution_id: "ActionExecutionId", # required
  filters: [
    {
      name: "TARGET_STATUS", # accepts TARGET_STATUS
      values: ["TargetFilterValue"],
    },
  ],
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.targets #=> Array
resp.targets[0].target_id #=> String
resp.targets[0].target_type #=> String
resp.targets[0].status #=> String
resp.targets[0].start_time #=> Time
resp.targets[0].end_time #=> Time
resp.targets[0].events #=> Array
resp.targets[0].events[0].name #=> String
resp.targets[0].events[0].status #=> String
resp.targets[0].events[0].start_time #=> Time
resp.targets[0].events[0].end_time #=> Time
resp.targets[0].events[0].context.ssm_command_id #=> String
resp.targets[0].events[0].context.message #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :pipeline_name (String) —

    The name of the pipeline with the deploy action.

  • :action_execution_id (required, String) —

    The execution ID for the deploy action.

  • :filters (Array<Types::TargetFilter>) —

    Filters the targets for a specified deploy action.

  • :max_results (Integer) —

    The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value.

  • :next_token (String) —

    An identifier that was returned from the previous list action types call, which can be used to return the next set of action types in the list.

Returns:

See Also:



2094
2095
2096
2097
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 2094

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

#list_pipeline_executions(params = {}) ⇒ Types::ListPipelineExecutionsOutput

Gets a summary of the most recent executions for a pipeline.

When applying the filter for pipeline executions that have succeeded in the stage, the operation returns all executions in the current pipeline version beginning on February 1, 2024.

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

Examples:

Request syntax with placeholder values


resp = client.list_pipeline_executions({
  pipeline_name: "PipelineName", # required
  max_results: 1,
  filter: {
    succeeded_in_stage: {
      stage_name: "StageName",
    },
  },
  next_token: "NextToken",
})

Response structure


resp.pipeline_execution_summaries #=> Array
resp.pipeline_execution_summaries[0].pipeline_execution_id #=> String
resp.pipeline_execution_summaries[0].status #=> String, one of "Cancelled", "InProgress", "Stopped", "Stopping", "Succeeded", "Superseded", "Failed"
resp.pipeline_execution_summaries[0].status_summary #=> String
resp.pipeline_execution_summaries[0].start_time #=> Time
resp.pipeline_execution_summaries[0].last_update_time #=> Time
resp.pipeline_execution_summaries[0].source_revisions #=> Array
resp.pipeline_execution_summaries[0].source_revisions[0].action_name #=> String
resp.pipeline_execution_summaries[0].source_revisions[0].revision_id #=> String
resp.pipeline_execution_summaries[0].source_revisions[0].revision_summary #=> String
resp.pipeline_execution_summaries[0].source_revisions[0].revision_url #=> String
resp.pipeline_execution_summaries[0].trigger.trigger_type #=> String, one of "CreatePipeline", "StartPipelineExecution", "PollForSourceChanges", "Webhook", "CloudWatchEvent", "PutActionRevision", "WebhookV2", "ManualRollback", "AutomatedRollback"
resp.pipeline_execution_summaries[0].trigger.trigger_detail #=> String
resp.pipeline_execution_summaries[0].stop_trigger.reason #=> String
resp.pipeline_execution_summaries[0].execution_mode #=> String, one of "QUEUED", "SUPERSEDED", "PARALLEL"
resp.pipeline_execution_summaries[0].execution_type #=> String, one of "STANDARD", "ROLLBACK"
resp.pipeline_execution_summaries[0].rollback_metadata.rollback_target_pipeline_execution_id #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :pipeline_name (required, String) —

    The name of the pipeline for which you want to get execution summary information.

  • :max_results (Integer) —

    The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value. Pipeline history is limited to the most recent 12 months, based on pipeline execution start times. Default value is 100.

  • :filter (Types::PipelineExecutionFilter) —

    The pipeline execution to filter on.

  • :next_token (String) —

    The token that was returned from the previous ListPipelineExecutions call, which can be used to return the next set of pipeline executions in the list.

Returns:

See Also:



2170
2171
2172
2173
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 2170

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

#list_pipelines(params = {}) ⇒ Types::ListPipelinesOutput

Gets a summary of all of the pipelines associated with your account.

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

Examples:

Request syntax with placeholder values


resp = client.list_pipelines({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.pipelines #=> Array
resp.pipelines[0].name #=> String
resp.pipelines[0].version #=> Integer
resp.pipelines[0].pipeline_type #=> String, one of "V1", "V2"
resp.pipelines[0].execution_mode #=> String, one of "QUEUED", "SUPERSEDED", "PARALLEL"
resp.pipelines[0].created #=> Time
resp.pipelines[0].updated #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    An identifier that was returned from the previous list pipelines call. It can be used to return the next set of pipelines in the list.

  • :max_results (Integer) —

    The maximum number of pipelines to return in a single call. To retrieve the remaining pipelines, make another call with the returned nextToken value. The minimum value you can specify is 1. The maximum accepted value is 1000.

Returns:

See Also:



2216
2217
2218
2219
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 2216

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

#list_rule_executions(params = {}) ⇒ Types::ListRuleExecutionsOutput

Lists the rule executions that have occurred in a pipeline configured for conditions with rules.

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

Examples:

Request syntax with placeholder values


resp = client.list_rule_executions({
  pipeline_name: "PipelineName", # required
  filter: {
    pipeline_execution_id: "PipelineExecutionId",
    latest_in_pipeline_execution: {
      pipeline_execution_id: "PipelineExecutionId", # required
      start_time_range: "Latest", # required, accepts Latest, All
    },
  },
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.rule_execution_details #=> Array
resp.rule_execution_details[0].pipeline_execution_id #=> String
resp.rule_execution_details[0].rule_execution_id #=> String
resp.rule_execution_details[0].pipeline_version #=> Integer
resp.rule_execution_details[0].stage_name #=> String
resp.rule_execution_details[0].rule_name #=> String
resp.rule_execution_details[0].start_time #=> Time
resp.rule_execution_details[0].last_update_time #=> Time
resp.rule_execution_details[0].updated_by #=> String
resp.rule_execution_details[0].status #=> String, one of "InProgress", "Abandoned", "Succeeded", "Failed"
resp.rule_execution_details[0].input.rule_type_id.category #=> String, one of "Rule"
resp.rule_execution_details[0].input.rule_type_id.owner #=> String, one of "AWS"
resp.rule_execution_details[0].input.rule_type_id.provider #=> String
resp.rule_execution_details[0].input.rule_type_id.version #=> String
resp.rule_execution_details[0].input.configuration #=> Hash
resp.rule_execution_details[0].input.configuration["RuleConfigurationKey"] #=> String
resp.rule_execution_details[0].input.resolved_configuration #=> Hash
resp.rule_execution_details[0].input.resolved_configuration["String"] #=> String
resp.rule_execution_details[0].input.role_arn #=> String
resp.rule_execution_details[0].input.region #=> String
resp.rule_execution_details[0].input.input_artifacts #=> Array
resp.rule_execution_details[0].input.input_artifacts[0].name #=> String
resp.rule_execution_details[0].input.input_artifacts[0].s3location.bucket #=> String
resp.rule_execution_details[0].input.input_artifacts[0].s3location.key #=> String
resp.rule_execution_details[0].output.execution_result.external_execution_id #=> String
resp.rule_execution_details[0].output.execution_result.external_execution_summary #=> String
resp.rule_execution_details[0].output.execution_result.external_execution_url #=> String
resp.rule_execution_details[0].output.execution_result.error_details.code #=> String
resp.rule_execution_details[0].output.execution_result.error_details.message #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :pipeline_name (required, String) —

    The name of the pipeline for which you want to get execution summary information.

  • :filter (Types::RuleExecutionFilter) —

    Input information used to filter rule execution history.

  • :max_results (Integer) —

    The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value. Pipeline history is limited to the most recent 12 months, based on pipeline execution start times. Default value is 100.

  • :next_token (String) —

    The token that was returned from the previous ListRuleExecutions call, which can be used to return the next set of rule executions in the list.

Returns:

See Also:



2301
2302
2303
2304
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 2301

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

#list_rule_types(params = {}) ⇒ Types::ListRuleTypesOutput

Lists the rules for the condition. For more information about conditions, see Stage conditions and How do stage conditions work?.For more information about rules, see the CodePipeline rule reference.

Examples:

Request syntax with placeholder values


resp = client.list_rule_types({
  rule_owner_filter: "AWS", # accepts AWS
  region_filter: "AWSRegionName",
})

Response structure


resp.rule_types #=> Array
resp.rule_types[0].id.category #=> String, one of "Rule"
resp.rule_types[0].id.owner #=> String, one of "AWS"
resp.rule_types[0].id.provider #=> String
resp.rule_types[0].id.version #=> String
resp.rule_types[0].settings.third_party_configuration_url #=> String
resp.rule_types[0].settings.entity_url_template #=> String
resp.rule_types[0].settings.execution_url_template #=> String
resp.rule_types[0].settings.revision_url_template #=> String
resp.rule_types[0].rule_configuration_properties #=> Array
resp.rule_types[0].rule_configuration_properties[0].name #=> String
resp.rule_types[0].rule_configuration_properties[0].required #=> Boolean
resp.rule_types[0].rule_configuration_properties[0].key #=> Boolean
resp.rule_types[0].rule_configuration_properties[0].secret #=> Boolean
resp.rule_types[0].rule_configuration_properties[0].queryable #=> Boolean
resp.rule_types[0].rule_configuration_properties[0].description #=> String
resp.rule_types[0].rule_configuration_properties[0].type #=> String, one of "String", "Number", "Boolean"
resp.rule_types[0].input_artifact_details.minimum_count #=> Integer
resp.rule_types[0].input_artifact_details.maximum_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :rule_owner_filter (String) —

    The rule owner to filter on.

  • :region_filter (String) —

    The rule Region to filter on.

Returns:

See Also:



2360
2361
2362
2363
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 2360

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

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput

Gets the set of key-value pairs (metadata) that are used to manage the resource.

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

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "ResourceArn", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource to get tags for.

  • :next_token (String) —

    The token that was returned from the previous API call, which would be used to return the next page of the list. The ListTagsforResource call lists all available tags in one call and does not use pagination.

  • :max_results (Integer) —

    The maximum number of results to return in a single call.

Returns:

See Also:



2405
2406
2407
2408
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 2405

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

#list_webhooks(params = {}) ⇒ Types::ListWebhooksOutput

Gets a listing of all the webhooks in this Amazon Web Services Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration for each webhook.

If a secret token was provided, it will be redacted in the response.

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

Examples:

Request syntax with placeholder values


resp = client.list_webhooks({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.webhooks #=> Array
resp.webhooks[0].definition.name #=> String
resp.webhooks[0].definition.target_pipeline #=> String
resp.webhooks[0].definition.target_action #=> String
resp.webhooks[0].definition.filters #=> Array
resp.webhooks[0].definition.filters[0].json_path #=> String
resp.webhooks[0].definition.filters[0].match_equals #=> String
resp.webhooks[0].definition.authentication #=> String, one of "GITHUB_HMAC", "IP", "UNAUTHENTICATED"
resp.webhooks[0].definition.authentication_configuration.allowed_ip_range #=> String
resp.webhooks[0].definition.authentication_configuration.secret_token #=> String
resp.webhooks[0].url #=> String
resp.webhooks[0].error_message #=> String
resp.webhooks[0].error_code #=> String
resp.webhooks[0].last_triggered #=> Time
resp.webhooks[0].arn #=> String
resp.webhooks[0].tags #=> Array
resp.webhooks[0].tags[0].key #=> String
resp.webhooks[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The token that was returned from the previous ListWebhooks call, which can be used to return the next set of webhooks in the list.

  • :max_results (Integer) —

    The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Returns:

See Also:



2467
2468
2469
2470
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 2467

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

#override_stage_condition(params = {}) ⇒ Struct

Used to override a stage condition. For more information about conditions, see Stage conditions and How do stage conditions work?.

Examples:

Request syntax with placeholder values


resp = client.override_stage_condition({
  pipeline_name: "PipelineName", # required
  stage_name: "StageName", # required
  pipeline_execution_id: "PipelineExecutionId", # required
  condition_type: "BEFORE_ENTRY", # required, accepts BEFORE_ENTRY, ON_SUCCESS
})

Parameters:

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

    ({})

Options Hash (params):

  • :pipeline_name (required, String) —

    The name of the pipeline with the stage that will override the condition.

  • :stage_name (required, String) —

    The name of the stage for the override.

  • :pipeline_execution_id (required, String) —

    The ID of the pipeline execution for the override.

  • :condition_type (required, String) —

    The type of condition to override for the stage, such as entry conditions, failure conditions, or success conditions.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2510
2511
2512
2513
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 2510

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

#poll_for_jobs(params = {}) ⇒ Types::PollForJobsOutput

Returns information about any jobs for CodePipeline to act on. PollForJobs is valid only for action types with "Custom" in the owner field. If the action type contains AWS or ThirdParty in the owner field, the PollForJobs action returns an error.

When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.

Examples:

Request syntax with placeholder values


resp = client.poll_for_jobs({
  action_type_id: { # required
    category: "Source", # required, accepts Source, Build, Deploy, Test, Invoke, Approval, Compute
    owner: "AWS", # required, accepts AWS, ThirdParty, Custom
    provider: "ActionProvider", # required
    version: "Version", # required
  },
  max_batch_size: 1,
  query_param: {
    "ActionConfigurationKey" => "ActionConfigurationQueryableValue",
  },
})

Response structure


resp.jobs #=> Array
resp.jobs[0].id #=> String
resp.jobs[0].data.action_type_id.category #=> String, one of "Source", "Build", "Deploy", "Test", "Invoke", "Approval", "Compute"
resp.jobs[0].data.action_type_id.owner #=> String, one of "AWS", "ThirdParty", "Custom"
resp.jobs[0].data.action_type_id.provider #=> String
resp.jobs[0].data.action_type_id.version #=> String
resp.jobs[0].data.action_configuration.configuration #=> Hash
resp.jobs[0].data.action_configuration.configuration["ActionConfigurationKey"] #=> String
resp.jobs[0].data.pipeline_context.pipeline_name #=> String
resp.jobs[0].data.pipeline_context.stage.name #=> String
resp.jobs[0].data.pipeline_context.action.name #=> String
resp.jobs[0].data.pipeline_context.action.action_execution_id #=> String
resp.jobs[0].data.pipeline_context.pipeline_arn #=> String
resp.jobs[0].data.pipeline_context.pipeline_execution_id #=> String
resp.jobs[0].data.input_artifacts #=> Array
resp.jobs[0].data.input_artifacts[0].name #=> String
resp.jobs[0].data.input_artifacts[0].revision #=> String
resp.jobs[0].data.input_artifacts[0].location.type #=> String, one of "S3"
resp.jobs[0].data.input_artifacts[0].location.s3_location.bucket_name #=> String
resp.jobs[0].data.input_artifacts[0].location.s3_location.object_key #=> String
resp.jobs[0].data.output_artifacts #=> Array
resp.jobs[0].data.output_artifacts[0].name #=> String
resp.jobs[0].data.output_artifacts[0].revision #=> String
resp.jobs[0].data.output_artifacts[0].location.type #=> String, one of "S3"
resp.jobs[0].data.output_artifacts[0].location.s3_location.bucket_name #=> String
resp.jobs[0].data.output_artifacts[0].location.s3_location.object_key #=> String
resp.jobs[0].data.artifact_credentials.access_key_id #=> String
resp.jobs[0].data.artifact_credentials.secret_access_key #=> String
resp.jobs[0].data.artifact_credentials.session_token #=> String
resp.jobs[0].data.continuation_token #=> String
resp.jobs[0].data.encryption_key.id #=> String
resp.jobs[0].data.encryption_key.type #=> String, one of "KMS"
resp.jobs[0].nonce #=> String
resp.jobs[0]. #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :action_type_id (required, Types::ActionTypeId) —

    Represents information about an action type.

  • :max_batch_size (Integer) —

    The maximum number of jobs to return in a poll for jobs call.

  • :query_param (Hash<String,String>) —

    A map of property names and values. For an action type with no queryable properties, this value must be null or an empty map. For an action type with a queryable property, you must supply that property as a key in the map. Only jobs whose action configuration matches the mapped value are returned.

Returns:

See Also:



2599
2600
2601
2602
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 2599

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

#poll_for_third_party_jobs(params = {}) ⇒ Types::PollForThirdPartyJobsOutput

Determines whether there are any third party jobs for a job worker to act on. Used for partner actions only.

When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts.

Examples:

Request syntax with placeholder values


resp = client.poll_for_third_party_jobs({
  action_type_id: { # required
    category: "Source", # required, accepts Source, Build, Deploy, Test, Invoke, Approval, Compute
    owner: "AWS", # required, accepts AWS, ThirdParty, Custom
    provider: "ActionProvider", # required
    version: "Version", # required
  },
  max_batch_size: 1,
})

Response structure


resp.jobs #=> Array
resp.jobs[0].client_id #=> String
resp.jobs[0].job_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :action_type_id (required, Types::ActionTypeId) —

    Represents information about an action type.

  • :max_batch_size (Integer) —

    The maximum number of jobs to return in a poll for jobs call.

Returns:

See Also:



2644
2645
2646
2647
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 2644

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

#put_action_revision(params = {}) ⇒ Types::PutActionRevisionOutput

Provides information to CodePipeline about new revisions to a source.

Examples:

Request syntax with placeholder values


resp = client.put_action_revision({
  pipeline_name: "PipelineName", # required
  stage_name: "StageName", # required
  action_name: "ActionName", # required
  action_revision: { # required
    revision_id: "Revision", # required
    revision_change_id: "RevisionChangeIdentifier", # required
    created: Time.now, # required
  },
})

Response structure


resp.new_revision #=> Boolean
resp.pipeline_execution_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :pipeline_name (required, String) —

    The name of the pipeline that starts processing the revision to the source.

  • :stage_name (required, String) —

    The name of the stage that contains the action that acts on the revision.

  • :action_name (required, String) —

    The name of the action that processes the revision.

  • :action_revision (required, Types::ActionRevision) —

    Represents information about the version (or revision) of an action.

Returns:

See Also:



2692
2693
2694
2695
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 2692

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

#put_approval_result(params = {}) ⇒ Types::PutApprovalResultOutput

Provides the response to a manual approval request to CodePipeline. Valid responses include Approved and Rejected.

Examples:

Request syntax with placeholder values


resp = client.put_approval_result({
  pipeline_name: "PipelineName", # required
  stage_name: "StageName", # required
  action_name: "ActionName", # required
  result: { # required
    summary: "ApprovalSummary", # required
    status: "Approved", # required, accepts Approved, Rejected
  },
  token: "ApprovalToken", # required
})

Response structure


resp.approved_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :pipeline_name (required, String) —

    The name of the pipeline that contains the action.

  • :stage_name (required, String) —

    The name of the stage that contains the action.

  • :action_name (required, String) —

    The name of the action for which approval is requested.

  • :result (required, Types::ApprovalResult) —

    Represents information about the result of the approval request.

  • :token (required, String) —

    The system-generated token used to identify a unique approval request. The token for each open approval request can be obtained using the GetPipelineState action. It is used to validate that the approval request corresponding to this token is still valid.

    For a pipeline where the execution mode is set to PARALLEL, the token required to approve/reject an approval request as detailed above is not available. Instead, use the externalExecutionId in the response output from the ListActionExecutions action as the token in the approval request.

Returns:

See Also:



2749
2750
2751
2752
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 2749

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

#put_job_failure_result(params = {}) ⇒ Struct

Represents the failure of a job as returned to the pipeline by a job worker. Used for custom actions only.

Examples:

Request syntax with placeholder values


resp = client.put_job_failure_result({
  job_id: "JobId", # required
  failure_details: { # required
    type: "JobFailed", # required, accepts JobFailed, ConfigurationError, PermissionError, RevisionOutOfSync, RevisionUnavailable, SystemUnavailable
    message: "Message", # required
    external_execution_id: "ExecutionId",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The unique system-generated ID of the job that failed. This is the same ID returned from PollForJobs.

  • :failure_details (required, Types::FailureDetails) —

    The details about the failure of a job.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2781
2782
2783
2784
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 2781

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

#put_job_success_result(params = {}) ⇒ Struct

Represents the success of a job as returned to the pipeline by a job worker. Used for custom actions only.

Examples:

Request syntax with placeholder values


resp = client.put_job_success_result({
  job_id: "JobId", # required
  current_revision: {
    revision: "Revision", # required
    change_identifier: "RevisionChangeIdentifier", # required
    created: Time.now,
    revision_summary: "RevisionSummary",
  },
  continuation_token: "ContinuationToken",
  execution_details: {
    summary: "ExecutionSummary",
    external_execution_id: "ExecutionId",
    percent_complete: 1,
  },
  output_variables: {
    "OutputVariablesKey" => "OutputVariablesValue",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The unique system-generated ID of the job that succeeded. This is the same ID returned from PollForJobs.

  • :current_revision (Types::CurrentRevision) —

    The ID of the current revision of the artifact successfully worked on by the job.

  • :continuation_token (String) —

    A token generated by a job worker, such as a CodeDeploy deployment ID, that a successful job provides to identify a custom action in progress. Future jobs use this token to identify the running instance of the action. It can be reused to return more information about the progress of the custom action. When the action is complete, no continuation token should be supplied.

  • :execution_details (Types::ExecutionDetails) —

    The execution details of the successful job, such as the actions taken by the job worker.

  • :output_variables (Hash<String,String>) —

    Key-value pairs produced as output by a job worker that can be made available to a downstream action configuration. outputVariables can be included only when there is no continuation token on the request.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2841
2842
2843
2844
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 2841

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

#put_third_party_job_failure_result(params = {}) ⇒ Struct

Represents the failure of a third party job as returned to the pipeline by a job worker. Used for partner actions only.

Examples:

Request syntax with placeholder values


resp = client.put_third_party_job_failure_result({
  job_id: "ThirdPartyJobId", # required
  client_token: "ClientToken", # required
  failure_details: { # required
    type: "JobFailed", # required, accepts JobFailed, ConfigurationError, PermissionError, RevisionOutOfSync, RevisionUnavailable, SystemUnavailable
    message: "Message", # required
    external_execution_id: "ExecutionId",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The ID of the job that failed. This is the same ID returned from PollForThirdPartyJobs.

  • :client_token (required, String) —

    The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.

  • :failure_details (required, Types::FailureDetails) —

    Represents information about failure details.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2879
2880
2881
2882
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 2879

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

#put_third_party_job_success_result(params = {}) ⇒ Struct

Represents the success of a third party job as returned to the pipeline by a job worker. Used for partner actions only.

Examples:

Request syntax with placeholder values


resp = client.put_third_party_job_success_result({
  job_id: "ThirdPartyJobId", # required
  client_token: "ClientToken", # required
  current_revision: {
    revision: "Revision", # required
    change_identifier: "RevisionChangeIdentifier", # required
    created: Time.now,
    revision_summary: "RevisionSummary",
  },
  continuation_token: "ContinuationToken",
  execution_details: {
    summary: "ExecutionSummary",
    external_execution_id: "ExecutionId",
    percent_complete: 1,
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The ID of the job that successfully completed. This is the same ID returned from PollForThirdPartyJobs.

  • :client_token (required, String) —

    The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.

  • :current_revision (Types::CurrentRevision) —

    Represents information about a current revision.

  • :continuation_token (String) —

    A token generated by a job worker, such as a CodeDeploy deployment ID, that a successful job provides to identify a partner action in progress. Future jobs use this token to identify the running instance of the action. It can be reused to return more information about the progress of the partner action. When the action is complete, no continuation token should be supplied.

  • :execution_details (Types::ExecutionDetails) —

    The details of the actions taken and results produced on an artifact as it passes through stages in the pipeline.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2936
2937
2938
2939
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 2936

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

#put_webhook(params = {}) ⇒ Types::PutWebhookOutput

Defines a webhook and returns a unique webhook URL generated by CodePipeline. This URL can be supplied to third party source hosting providers to call every time there's a code change. When CodePipeline receives a POST request on this URL, the pipeline defined in the webhook is started as long as the POST request satisfied the authentication and filtering requirements supplied when defining the webhook. RegisterWebhookWithThirdParty and DeregisterWebhookWithThirdParty APIs can be used to automatically configure supported third parties to call the generated webhook URL.

When creating CodePipeline webhooks, do not use your own credentials or reuse the same secret token across multiple webhooks. For optimal security, generate a unique secret token for each webhook you create. The secret token is an arbitrary string that you provide, which GitHub uses to compute and sign the webhook payloads sent to CodePipeline, for protecting the integrity and authenticity of the webhook payloads. Using your own credentials or reusing the same token across multiple webhooks can lead to security vulnerabilities.

If a secret token was provided, it will be redacted in the response.

Examples:

Request syntax with placeholder values


resp = client.put_webhook({
  webhook: { # required
    name: "WebhookName", # required
    target_pipeline: "PipelineName", # required
    target_action: "ActionName", # required
    filters: [ # required
      {
        json_path: "JsonPath", # required
        match_equals: "MatchEquals",
      },
    ],
    authentication: "GITHUB_HMAC", # required, accepts GITHUB_HMAC, IP, UNAUTHENTICATED
    authentication_configuration: { # required
      allowed_ip_range: "WebhookAuthConfigurationAllowedIPRange",
      secret_token: "WebhookAuthConfigurationSecretToken",
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.webhook.definition.name #=> String
resp.webhook.definition.target_pipeline #=> String
resp.webhook.definition.target_action #=> String
resp.webhook.definition.filters #=> Array
resp.webhook.definition.filters[0].json_path #=> String
resp.webhook.definition.filters[0].match_equals #=> String
resp.webhook.definition.authentication #=> String, one of "GITHUB_HMAC", "IP", "UNAUTHENTICATED"
resp.webhook.definition.authentication_configuration.allowed_ip_range #=> String
resp.webhook.definition.authentication_configuration.secret_token #=> String
resp.webhook.url #=> String
resp.webhook.error_message #=> String
resp.webhook.error_code #=> String
resp.webhook.last_triggered #=> Time
resp.webhook.arn #=> String
resp.webhook.tags #=> Array
resp.webhook.tags[0].key #=> String
resp.webhook.tags[0].value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :webhook (required, Types::WebhookDefinition) —

    The detail provided in an input file to create the webhook, such as the webhook name, the pipeline name, and the action name. Give the webhook a unique name that helps you identify it. You might name the webhook after the pipeline and action it targets so that you can easily recognize what it's used for later.

  • :tags (Array<Types::Tag>) —

    The tags for the webhook.

Returns:

See Also:



3029
3030
3031
3032
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 3029

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

#register_webhook_with_third_party(params = {}) ⇒ Struct

Configures a connection between the webhook that was created and the external tool with events to be detected.

Examples:

Request syntax with placeholder values


resp = client.register_webhook_with_third_party({
  webhook_name: "WebhookName",
})

Parameters:

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

    ({})

Options Hash (params):

  • :webhook_name (String) —

    The name of an existing webhook created with PutWebhook to register with a supported third party.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3053
3054
3055
3056
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 3053

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

#retry_stage_execution(params = {}) ⇒ Types::RetryStageExecutionOutput

You can retry a stage that has failed without having to run a pipeline again from the beginning. You do this by either retrying the failed actions in a stage or by retrying all actions in the stage starting from the first action in the stage. When you retry the failed actions in a stage, all actions that are still in progress continue working, and failed actions are triggered again. When you retry a failed stage from the first action in the stage, the stage cannot have any actions in progress. Before a stage can be retried, it must either have all actions failed or some actions failed and some succeeded.

Examples:

Request syntax with placeholder values


resp = client.retry_stage_execution({
  pipeline_name: "PipelineName", # required
  stage_name: "StageName", # required
  pipeline_execution_id: "PipelineExecutionId", # required
  retry_mode: "FAILED_ACTIONS", # required, accepts FAILED_ACTIONS, ALL_ACTIONS
})

Response structure


resp.pipeline_execution_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :pipeline_name (required, String) —

    The name of the pipeline that contains the failed stage.

  • :stage_name (required, String) —

    The name of the failed stage to be retried.

  • :pipeline_execution_id (required, String) —

    The ID of the pipeline execution in the failed stage to be retried. Use the GetPipelineState action to retrieve the current pipelineExecutionId of the failed stage

  • :retry_mode (required, String) —

    The scope of the retry attempt.

Returns:

See Also:



3103
3104
3105
3106
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 3103

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

#rollback_stage(params = {}) ⇒ Types::RollbackStageOutput

Rolls back a stage execution.

Examples:

Request syntax with placeholder values


resp = client.rollback_stage({
  pipeline_name: "PipelineName", # required
  stage_name: "StageName", # required
  target_pipeline_execution_id: "PipelineExecutionId", # required
})

Response structure


resp.pipeline_execution_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :pipeline_name (required, String) —

    The name of the pipeline for which the stage will be rolled back.

  • :stage_name (required, String) —

    The name of the stage in the pipeline to be rolled back.

  • :target_pipeline_execution_id (required, String) —

    The pipeline execution ID for the stage to be rolled back to.

Returns:

See Also:



3139
3140
3141
3142
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 3139

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

#start_pipeline_execution(params = {}) ⇒ Types::StartPipelineExecutionOutput

Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.

Examples:

Request syntax with placeholder values


resp = client.start_pipeline_execution({
  name: "PipelineName", # required
  variables: [
    {
      name: "PipelineVariableName", # required
      value: "PipelineVariableValue", # required
    },
  ],
  client_request_token: "ClientRequestToken",
  source_revisions: [
    {
      action_name: "ActionName", # required
      revision_type: "COMMIT_ID", # required, accepts COMMIT_ID, IMAGE_DIGEST, S3_OBJECT_VERSION_ID, S3_OBJECT_KEY
      revision_value: "Revision", # required
    },
  ],
})

Response structure


resp.pipeline_execution_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the pipeline to start.

  • :variables (Array<Types::PipelineVariable>) —

    A list that overrides pipeline variables for a pipeline execution that's being started. Variable names must match [A-Za-z0-9@\-_]+, and the values can be anything except an empty string.

  • :client_request_token (String) —

    The system-generated unique ID used to identify a unique execution request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :source_revisions (Array<Types::SourceRevisionOverride>) —

    A list that allows you to specify, or override, the source revision for a pipeline execution that's being started. A source revision is the version with all the changes to your application code, or source artifact, for the pipeline execution.

Returns:

See Also:



3201
3202
3203
3204
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 3201

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

#stop_pipeline_execution(params = {}) ⇒ Types::StopPipelineExecutionOutput

Stops the specified pipeline execution. You choose to either stop the pipeline execution by completing in-progress actions without starting subsequent actions, or by abandoning in-progress actions. While completing or abandoning in-progress actions, the pipeline execution is in a Stopping state. After all in-progress actions are completed or abandoned, the pipeline execution is in a Stopped state.

Examples:

Request syntax with placeholder values


resp = client.stop_pipeline_execution({
  pipeline_name: "PipelineName", # required
  pipeline_execution_id: "PipelineExecutionId", # required
  abandon: false,
  reason: "StopPipelineExecutionReason",
})

Response structure


resp.pipeline_execution_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :pipeline_name (required, String) —

    The name of the pipeline to stop.

  • :pipeline_execution_id (required, String) —

    The ID of the pipeline execution to be stopped in the current stage. Use the GetPipelineState action to retrieve the current pipelineExecutionId.

  • :abandon (Boolean) —

    Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.

    This option can lead to failed or out-of-sequence tasks.

  • :reason (String) —

    Use this option to enter comments, such as the reason the pipeline was stopped.

Returns:

See Also:



3254
3255
3256
3257
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 3254

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

#tag_resource(params = {}) ⇒ Struct

Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "ResourceArn", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource you want to add tags to.

  • :tags (required, Array<Types::Tag>) —

    The tags you want to modify or add to the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3287
3288
3289
3290
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 3287

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

#untag_resource(params = {}) ⇒ Struct

Removes tags from an Amazon Web Services resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "ResourceArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource to remove tags from.

  • :tag_keys (required, Array<String>) —

    The list of keys for the tags to be removed from the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3313
3314
3315
3316
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 3313

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

#update_action_type(params = {}) ⇒ Struct

Updates an action type that was created with any supported integration model, where the action type is to be used by customers of the action type provider. Use a JSON file with the action definition and UpdateActionType to provide the full structure.

Examples:

Request syntax with placeholder values


resp = client.update_action_type({
  action_type: { # required
    description: "ActionTypeDescription",
    executor: { # required
      configuration: { # required
        lambda_executor_configuration: {
          lambda_function_arn: "LambdaFunctionArn", # required
        },
        job_worker_executor_configuration: {
          polling_accounts: ["AccountId"],
          polling_service_principals: ["ServicePrincipal"],
        },
      },
      type: "JobWorker", # required, accepts JobWorker, Lambda
      policy_statements_template: "PolicyStatementsTemplate",
      job_timeout: 1,
    },
    id: { # required
      category: "Source", # required, accepts Source, Build, Deploy, Test, Invoke, Approval, Compute
      owner: "ActionTypeOwner", # required
      provider: "ActionProvider", # required
      version: "Version", # required
    },
    input_artifact_details: { # required
      minimum_count: 1, # required
      maximum_count: 1, # required
    },
    output_artifact_details: { # required
      minimum_count: 1, # required
      maximum_count: 1, # required
    },
    permissions: {
      allowed_accounts: ["AllowedAccount"], # required
    },
    properties: [
      {
        name: "ActionConfigurationKey", # required
        optional: false, # required
        key: false, # required
        no_echo: false, # required
        queryable: false,
        description: "PropertyDescription",
      },
    ],
    urls: {
      configuration_url: "Url",
      entity_url_template: "UrlTemplate",
      execution_url_template: "UrlTemplate",
      revision_url_template: "UrlTemplate",
    },
  },
})

Parameters:

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

    ({})

Options Hash (params):

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3387
3388
3389
3390
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 3387

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

#update_pipeline(params = {}) ⇒ Types::UpdatePipelineOutput

Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure and UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1.

Examples:

Request syntax with placeholder values


resp = client.update_pipeline({
  pipeline: { # required
    name: "PipelineName", # required
    role_arn: "RoleArn", # required
    artifact_store: {
      type: "S3", # required, accepts S3
      location: "ArtifactStoreLocation", # required
      encryption_key: {
        id: "EncryptionKeyId", # required
        type: "KMS", # required, accepts KMS
      },
    },
    artifact_stores: {
      "AWSRegionName" => {
        type: "S3", # required, accepts S3
        location: "ArtifactStoreLocation", # required
        encryption_key: {
          id: "EncryptionKeyId", # required
          type: "KMS", # required, accepts KMS
        },
      },
    },
    stages: [ # required
      {
        name: "StageName", # required
        blockers: [
          {
            name: "BlockerName", # required
            type: "Schedule", # required, accepts Schedule
          },
        ],
        actions: [ # required
          {
            name: "ActionName", # required
            action_type_id: { # required
              category: "Source", # required, accepts Source, Build, Deploy, Test, Invoke, Approval, Compute
              owner: "AWS", # required, accepts AWS, ThirdParty, Custom
              provider: "ActionProvider", # required
              version: "Version", # required
            },
            run_order: 1,
            configuration: {
              "ActionConfigurationKey" => "ActionConfigurationValue",
            },
            commands: ["Command"],
            output_artifacts: [
              {
                name: "ArtifactName", # required
                files: ["FilePath"],
              },
            ],
            input_artifacts: [
              {
                name: "ArtifactName", # required
              },
            ],
            output_variables: ["OutputVariable"],
            role_arn: "RoleArn",
            region: "AWSRegionName",
            namespace: "ActionNamespace",
            timeout_in_minutes: 1,
            environment_variables: [
              {
                name: "EnvironmentVariableName", # required
                value: "EnvironmentVariableValue", # required
                type: "PLAINTEXT", # accepts PLAINTEXT, SECRETS_MANAGER
              },
            ],
          },
        ],
        on_failure: {
          result: "ROLLBACK", # accepts ROLLBACK, FAIL, RETRY, SKIP
          retry_configuration: {
            retry_mode: "FAILED_ACTIONS", # accepts FAILED_ACTIONS, ALL_ACTIONS
          },
          conditions: [
            {
              result: "ROLLBACK", # accepts ROLLBACK, FAIL, RETRY, SKIP
              rules: [
                {
                  name: "RuleName", # required
                  rule_type_id: { # required
                    category: "Rule", # required, accepts Rule
                    owner: "AWS", # accepts AWS
                    provider: "RuleProvider", # required
                    version: "Version",
                  },
                  configuration: {
                    "RuleConfigurationKey" => "RuleConfigurationValue",
                  },
                  commands: ["Command"],
                  input_artifacts: [
                    {
                      name: "ArtifactName", # required
                    },
                  ],
                  role_arn: "RoleArn",
                  region: "AWSRegionName",
                  timeout_in_minutes: 1,
                },
              ],
            },
          ],
        },
        on_success: {
          conditions: [ # required
            {
              result: "ROLLBACK", # accepts ROLLBACK, FAIL, RETRY, SKIP
              rules: [
                {
                  name: "RuleName", # required
                  rule_type_id: { # required
                    category: "Rule", # required, accepts Rule
                    owner: "AWS", # accepts AWS
                    provider: "RuleProvider", # required
                    version: "Version",
                  },
                  configuration: {
                    "RuleConfigurationKey" => "RuleConfigurationValue",
                  },
                  commands: ["Command"],
                  input_artifacts: [
                    {
                      name: "ArtifactName", # required
                    },
                  ],
                  role_arn: "RoleArn",
                  region: "AWSRegionName",
                  timeout_in_minutes: 1,
                },
              ],
            },
          ],
        },
        before_entry: {
          conditions: [ # required
            {
              result: "ROLLBACK", # accepts ROLLBACK, FAIL, RETRY, SKIP
              rules: [
                {
                  name: "RuleName", # required
                  rule_type_id: { # required
                    category: "Rule", # required, accepts Rule
                    owner: "AWS", # accepts AWS
                    provider: "RuleProvider", # required
                    version: "Version",
                  },
                  configuration: {
                    "RuleConfigurationKey" => "RuleConfigurationValue",
                  },
                  commands: ["Command"],
                  input_artifacts: [
                    {
                      name: "ArtifactName", # required
                    },
                  ],
                  role_arn: "RoleArn",
                  region: "AWSRegionName",
                  timeout_in_minutes: 1,
                },
              ],
            },
          ],
        },
      },
    ],
    version: 1,
    execution_mode: "QUEUED", # accepts QUEUED, SUPERSEDED, PARALLEL
    pipeline_type: "V1", # accepts V1, V2
    variables: [
      {
        name: "PipelineVariableName", # required
        default_value: "PipelineVariableValue",
        description: "PipelineVariableDescription",
      },
    ],
    triggers: [
      {
        provider_type: "CodeStarSourceConnection", # required, accepts CodeStarSourceConnection
        git_configuration: { # required
          source_action_name: "ActionName", # required
          push: [
            {
              tags: {
                includes: ["GitTagNamePattern"],
                excludes: ["GitTagNamePattern"],
              },
              branches: {
                includes: ["GitBranchNamePattern"],
                excludes: ["GitBranchNamePattern"],
              },
              file_paths: {
                includes: ["GitFilePathPattern"],
                excludes: ["GitFilePathPattern"],
              },
            },
          ],
          pull_request: [
            {
              events: ["OPEN"], # accepts OPEN, UPDATED, CLOSED
              branches: {
                includes: ["GitBranchNamePattern"],
                excludes: ["GitBranchNamePattern"],
              },
              file_paths: {
                includes: ["GitFilePathPattern"],
                excludes: ["GitFilePathPattern"],
              },
            },
          ],
        },
      },
    ],
  },
})

Response structure


resp.pipeline.name #=> String
resp.pipeline.role_arn #=> String
resp.pipeline.artifact_store.type #=> String, one of "S3"
resp.pipeline.artifact_store.location #=> String
resp.pipeline.artifact_store.encryption_key.id #=> String
resp.pipeline.artifact_store.encryption_key.type #=> String, one of "KMS"
resp.pipeline.artifact_stores #=> Hash
resp.pipeline.artifact_stores["AWSRegionName"].type #=> String, one of "S3"
resp.pipeline.artifact_stores["AWSRegionName"].location #=> String
resp.pipeline.artifact_stores["AWSRegionName"].encryption_key.id #=> String
resp.pipeline.artifact_stores["AWSRegionName"].encryption_key.type #=> String, one of "KMS"
resp.pipeline.stages #=> Array
resp.pipeline.stages[0].name #=> String
resp.pipeline.stages[0].blockers #=> Array
resp.pipeline.stages[0].blockers[0].name #=> String
resp.pipeline.stages[0].blockers[0].type #=> String, one of "Schedule"
resp.pipeline.stages[0].actions #=> Array
resp.pipeline.stages[0].actions[0].name #=> String
resp.pipeline.stages[0].actions[0].action_type_id.category #=> String, one of "Source", "Build", "Deploy", "Test", "Invoke", "Approval", "Compute"
resp.pipeline.stages[0].actions[0].action_type_id.owner #=> String, one of "AWS", "ThirdParty", "Custom"
resp.pipeline.stages[0].actions[0].action_type_id.provider #=> String
resp.pipeline.stages[0].actions[0].action_type_id.version #=> String
resp.pipeline.stages[0].actions[0].run_order #=> Integer
resp.pipeline.stages[0].actions[0].configuration #=> Hash
resp.pipeline.stages[0].actions[0].configuration["ActionConfigurationKey"] #=> String
resp.pipeline.stages[0].actions[0].commands #=> Array
resp.pipeline.stages[0].actions[0].commands[0] #=> String
resp.pipeline.stages[0].actions[0].output_artifacts #=> Array
resp.pipeline.stages[0].actions[0].output_artifacts[0].name #=> String
resp.pipeline.stages[0].actions[0].output_artifacts[0].files #=> Array
resp.pipeline.stages[0].actions[0].output_artifacts[0].files[0] #=> String
resp.pipeline.stages[0].actions[0].input_artifacts #=> Array
resp.pipeline.stages[0].actions[0].input_artifacts[0].name #=> String
resp.pipeline.stages[0].actions[0].output_variables #=> Array
resp.pipeline.stages[0].actions[0].output_variables[0] #=> String
resp.pipeline.stages[0].actions[0].role_arn #=> String
resp.pipeline.stages[0].actions[0].region #=> String
resp.pipeline.stages[0].actions[0].namespace #=> String
resp.pipeline.stages[0].actions[0].timeout_in_minutes #=> Integer
resp.pipeline.stages[0].actions[0].environment_variables #=> Array
resp.pipeline.stages[0].actions[0].environment_variables[0].name #=> String
resp.pipeline.stages[0].actions[0].environment_variables[0].value #=> String
resp.pipeline.stages[0].actions[0].environment_variables[0].type #=> String, one of "PLAINTEXT", "SECRETS_MANAGER"
resp.pipeline.stages[0].on_failure.result #=> String, one of "ROLLBACK", "FAIL", "RETRY", "SKIP"
resp.pipeline.stages[0].on_failure.retry_configuration.retry_mode #=> String, one of "FAILED_ACTIONS", "ALL_ACTIONS"
resp.pipeline.stages[0].on_failure.conditions #=> Array
resp.pipeline.stages[0].on_failure.conditions[0].result #=> String, one of "ROLLBACK", "FAIL", "RETRY", "SKIP"
resp.pipeline.stages[0].on_failure.conditions[0].rules #=> Array
resp.pipeline.stages[0].on_failure.conditions[0].rules[0].name #=> String
resp.pipeline.stages[0].on_failure.conditions[0].rules[0].rule_type_id.category #=> String, one of "Rule"
resp.pipeline.stages[0].on_failure.conditions[0].rules[0].rule_type_id.owner #=> String, one of "AWS"
resp.pipeline.stages[0].on_failure.conditions[0].rules[0].rule_type_id.provider #=> String
resp.pipeline.stages[0].on_failure.conditions[0].rules[0].rule_type_id.version #=> String
resp.pipeline.stages[0].on_failure.conditions[0].rules[0].configuration #=> Hash
resp.pipeline.stages[0].on_failure.conditions[0].rules[0].configuration["RuleConfigurationKey"] #=> String
resp.pipeline.stages[0].on_failure.conditions[0].rules[0].commands #=> Array
resp.pipeline.stages[0].on_failure.conditions[0].rules[0].commands[0] #=> String
resp.pipeline.stages[0].on_failure.conditions[0].rules[0].input_artifacts #=> Array
resp.pipeline.stages[0].on_failure.conditions[0].rules[0].input_artifacts[0].name #=> String
resp.pipeline.stages[0].on_failure.conditions[0].rules[0].role_arn #=> String
resp.pipeline.stages[0].on_failure.conditions[0].rules[0].region #=> String
resp.pipeline.stages[0].on_failure.conditions[0].rules[0].timeout_in_minutes #=> Integer
resp.pipeline.stages[0].on_success.conditions #=> Array
resp.pipeline.stages[0].on_success.conditions[0].result #=> String, one of "ROLLBACK", "FAIL", "RETRY", "SKIP"
resp.pipeline.stages[0].on_success.conditions[0].rules #=> Array
resp.pipeline.stages[0].on_success.conditions[0].rules[0].name #=> String
resp.pipeline.stages[0].on_success.conditions[0].rules[0].rule_type_id.category #=> String, one of "Rule"
resp.pipeline.stages[0].on_success.conditions[0].rules[0].rule_type_id.owner #=> String, one of "AWS"
resp.pipeline.stages[0].on_success.conditions[0].rules[0].rule_type_id.provider #=> String
resp.pipeline.stages[0].on_success.conditions[0].rules[0].rule_type_id.version #=> String
resp.pipeline.stages[0].on_success.conditions[0].rules[0].configuration #=> Hash
resp.pipeline.stages[0].on_success.conditions[0].rules[0].configuration["RuleConfigurationKey"] #=> String
resp.pipeline.stages[0].on_success.conditions[0].rules[0].commands #=> Array
resp.pipeline.stages[0].on_success.conditions[0].rules[0].commands[0] #=> String
resp.pipeline.stages[0].on_success.conditions[0].rules[0].input_artifacts #=> Array
resp.pipeline.stages[0].on_success.conditions[0].rules[0].input_artifacts[0].name #=> String
resp.pipeline.stages[0].on_success.conditions[0].rules[0].role_arn #=> String
resp.pipeline.stages[0].on_success.conditions[0].rules[0].region #=> String
resp.pipeline.stages[0].on_success.conditions[0].rules[0].timeout_in_minutes #=> Integer
resp.pipeline.stages[0].before_entry.conditions #=> Array
resp.pipeline.stages[0].before_entry.conditions[0].result #=> String, one of "ROLLBACK", "FAIL", "RETRY", "SKIP"
resp.pipeline.stages[0].before_entry.conditions[0].rules #=> Array
resp.pipeline.stages[0].before_entry.conditions[0].rules[0].name #=> String
resp.pipeline.stages[0].before_entry.conditions[0].rules[0].rule_type_id.category #=> String, one of "Rule"
resp.pipeline.stages[0].before_entry.conditions[0].rules[0].rule_type_id.owner #=> String, one of "AWS"
resp.pipeline.stages[0].before_entry.conditions[0].rules[0].rule_type_id.provider #=> String
resp.pipeline.stages[0].before_entry.conditions[0].rules[0].rule_type_id.version #=> String
resp.pipeline.stages[0].before_entry.conditions[0].rules[0].configuration #=> Hash
resp.pipeline.stages[0].before_entry.conditions[0].rules[0].configuration["RuleConfigurationKey"] #=> String
resp.pipeline.stages[0].before_entry.conditions[0].rules[0].commands #=> Array
resp.pipeline.stages[0].before_entry.conditions[0].rules[0].commands[0] #=> String
resp.pipeline.stages[0].before_entry.conditions[0].rules[0].input_artifacts #=> Array
resp.pipeline.stages[0].before_entry.conditions[0].rules[0].input_artifacts[0].name #=> String
resp.pipeline.stages[0].before_entry.conditions[0].rules[0].role_arn #=> String
resp.pipeline.stages[0].before_entry.conditions[0].rules[0].region #=> String
resp.pipeline.stages[0].before_entry.conditions[0].rules[0].timeout_in_minutes #=> Integer
resp.pipeline.version #=> Integer
resp.pipeline.execution_mode #=> String, one of "QUEUED", "SUPERSEDED", "PARALLEL"
resp.pipeline.pipeline_type #=> String, one of "V1", "V2"
resp.pipeline.variables #=> Array
resp.pipeline.variables[0].name #=> String
resp.pipeline.variables[0].default_value #=> String
resp.pipeline.variables[0].description #=> String
resp.pipeline.triggers #=> Array
resp.pipeline.triggers[0].provider_type #=> String, one of "CodeStarSourceConnection"
resp.pipeline.triggers[0].git_configuration.source_action_name #=> String
resp.pipeline.triggers[0].git_configuration.push #=> Array
resp.pipeline.triggers[0].git_configuration.push[0].tags.includes #=> Array
resp.pipeline.triggers[0].git_configuration.push[0].tags.includes[0] #=> String
resp.pipeline.triggers[0].git_configuration.push[0].tags.excludes #=> Array
resp.pipeline.triggers[0].git_configuration.push[0].tags.excludes[0] #=> String
resp.pipeline.triggers[0].git_configuration.push[0].branches.includes #=> Array
resp.pipeline.triggers[0].git_configuration.push[0].branches.includes[0] #=> String
resp.pipeline.triggers[0].git_configuration.push[0].branches.excludes #=> Array
resp.pipeline.triggers[0].git_configuration.push[0].branches.excludes[0] #=> String
resp.pipeline.triggers[0].git_configuration.push[0].file_paths.includes #=> Array
resp.pipeline.triggers[0].git_configuration.push[0].file_paths.includes[0] #=> String
resp.pipeline.triggers[0].git_configuration.push[0].file_paths.excludes #=> Array
resp.pipeline.triggers[0].git_configuration.push[0].file_paths.excludes[0] #=> String
resp.pipeline.triggers[0].git_configuration.pull_request #=> Array
resp.pipeline.triggers[0].git_configuration.pull_request[0].events #=> Array
resp.pipeline.triggers[0].git_configuration.pull_request[0].events[0] #=> String, one of "OPEN", "UPDATED", "CLOSED"
resp.pipeline.triggers[0].git_configuration.pull_request[0].branches.includes #=> Array
resp.pipeline.triggers[0].git_configuration.pull_request[0].branches.includes[0] #=> String
resp.pipeline.triggers[0].git_configuration.pull_request[0].branches.excludes #=> Array
resp.pipeline.triggers[0].git_configuration.pull_request[0].branches.excludes[0] #=> String
resp.pipeline.triggers[0].git_configuration.pull_request[0].file_paths.includes #=> Array
resp.pipeline.triggers[0].git_configuration.pull_request[0].file_paths.includes[0] #=> String
resp.pipeline.triggers[0].git_configuration.pull_request[0].file_paths.excludes #=> Array
resp.pipeline.triggers[0].git_configuration.pull_request[0].file_paths.excludes[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



3759
3760
3761
3762
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/client.rb', line 3759

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