aws-sdk-codecatalyst 1.11.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef1913258526d65b5532eba31ec8631b8800892163f4140bc1bcf39d3a719e5b
-  data.tar.gz: 1b1078aa7b6a0975bb91c9ed161ec038715f378d1f1c57f47457013d50c40418
+  metadata.gz: 314a3f217ada79d632e17d60076b218c71253ae11dc57b5d9e06521aa4b0c0be
+  data.tar.gz: 4e273f3fba9af74ec3394fe0676f0af623b6668160b16ca6a6157a671b6bbcdd
 SHA512:
-  metadata.gz: 21a173609e3cfa095500608e131f875109fded23269f9cafd9222d98b3773322fcf6b79badebcea943f7db9d0249cd38fefdd1c7ef91e3317c70a78a4be50161
-  data.tar.gz: 4102706fc8ba675b5b2f5857e20db8051c00969d29f8d1f013366845398ceb8b823d15dfef46788bfcf43acd66138522e894f9f928ef62be833aee6a5c8ae82d
+  metadata.gz: 5374f0f4958ccf52be5c9e87ea1a30f9780fb381c9fc360483b6a11a58c70f937b84bc507ef27bf60f0e50110525aeb42730ebb8f26ed1c1c0045601ca8bd8cb
+  data.tar.gz: cc3d08f3cfa4b36d56806e858ffd8fe24bacadf34ef3c9190f172398a011824badc85e94f928ea5e97300d0274cd99825507c3ca2911c51bda790b146e3ad805

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.12.0 (2023-11-15)
+------------------
+
+* Feature - This release adds functionality for retrieving information about workflows and workflow runs and starting workflow runs in Amazon CodeCatalyst.
+
 1.11.0 (2023-09-27)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.11.0
+1.12.0

data/lib/aws-sdk-codecatalyst/client.rb

@@ -1180,6 +1180,116 @@ module Aws::CodeCatalyst
       req.send_request(options)
     end
 
+    # Returns information about a workflow.
+    #
+    # @option params [required, String] :space_name
+    #   The name of the space.
+    #
+    # @option params [required, String] :id
+    #   The ID of the workflow. To rerieve a list of workflow IDs, use
+    #   ListWorkflows.
+    #
+    # @option params [required, String] :project_name
+    #   The name of the project in the space.
+    #
+    # @return [Types::GetWorkflowResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetWorkflowResponse#space_name #space_name} => String
+    #   * {Types::GetWorkflowResponse#project_name #project_name} => String
+    #   * {Types::GetWorkflowResponse#id #id} => String
+    #   * {Types::GetWorkflowResponse#name #name} => String
+    #   * {Types::GetWorkflowResponse#source_repository_name #source_repository_name} => String
+    #   * {Types::GetWorkflowResponse#source_branch_name #source_branch_name} => String
+    #   * {Types::GetWorkflowResponse#definition #definition} => Types::WorkflowDefinition
+    #   * {Types::GetWorkflowResponse#created_time #created_time} => Time
+    #   * {Types::GetWorkflowResponse#last_updated_time #last_updated_time} => Time
+    #   * {Types::GetWorkflowResponse#run_mode #run_mode} => String
+    #   * {Types::GetWorkflowResponse#status #status} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_workflow({
+    #     space_name: "NameString", # required
+    #     id: "Uuid", # required
+    #     project_name: "GetWorkflowRequestProjectNameString", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.space_name #=> String
+    #   resp.project_name #=> String
+    #   resp.id #=> String
+    #   resp.name #=> String
+    #   resp.source_repository_name #=> String
+    #   resp.source_branch_name #=> String
+    #   resp.definition.path #=> String
+    #   resp.created_time #=> Time
+    #   resp.last_updated_time #=> Time
+    #   resp.run_mode #=> String, one of "QUEUED", "PARALLEL", "SUPERSEDED"
+    #   resp.status #=> String, one of "INVALID", "ACTIVE"
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/codecatalyst-2022-09-28/GetWorkflow AWS API Documentation
+    #
+    # @overload get_workflow(params = {})
+    # @param [Hash] params ({})
+    def get_workflow(params = {}, options = {})
+      req = build_request(:get_workflow, params)
+      req.send_request(options)
+    end
+
+    # Returns information about a specified run of a workflow.
+    #
+    # @option params [required, String] :space_name
+    #   The name of the space.
+    #
+    # @option params [required, String] :id
+    #   The ID of the workflow run. To retrieve a list of workflow run IDs,
+    #   use ListWorkflowRuns.
+    #
+    # @option params [required, String] :project_name
+    #   The name of the project in the space.
+    #
+    # @return [Types::GetWorkflowRunResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetWorkflowRunResponse#space_name #space_name} => String
+    #   * {Types::GetWorkflowRunResponse#project_name #project_name} => String
+    #   * {Types::GetWorkflowRunResponse#id #id} => String
+    #   * {Types::GetWorkflowRunResponse#workflow_id #workflow_id} => String
+    #   * {Types::GetWorkflowRunResponse#status #status} => String
+    #   * {Types::GetWorkflowRunResponse#status_reasons #status_reasons} => Array<Types::WorkflowRunStatusReason>
+    #   * {Types::GetWorkflowRunResponse#start_time #start_time} => Time
+    #   * {Types::GetWorkflowRunResponse#end_time #end_time} => Time
+    #   * {Types::GetWorkflowRunResponse#last_updated_time #last_updated_time} => Time
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_workflow_run({
+    #     space_name: "NameString", # required
+    #     id: "Uuid", # required
+    #     project_name: "GetWorkflowRunRequestProjectNameString", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.space_name #=> String
+    #   resp.project_name #=> String
+    #   resp.id #=> String
+    #   resp.workflow_id #=> String
+    #   resp.status #=> String, one of "SUCCEEDED", "FAILED", "STOPPED", "SUPERSEDED", "CANCELLED", "NOT_RUN", "VALIDATING", "PROVISIONING", "IN_PROGRESS", "STOPPING", "ABANDONED"
+    #   resp.status_reasons #=> Array
+    #   resp.start_time #=> Time
+    #   resp.end_time #=> Time
+    #   resp.last_updated_time #=> Time
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/codecatalyst-2022-09-28/GetWorkflowRun AWS API Documentation
+    #
+    # @overload get_workflow_run(params = {})
+    # @param [Hash] params ({})
+    def get_workflow_run(params = {}, options = {})
+      req = build_request(:get_workflow_run, params)
+      req.send_request(options)
+    end
+
     # Lists all personal access tokens (PATs) associated with the user who
     # calls the API. You can only list PATs associated with your Amazon Web
     # Services Builder ID.
@@ -1288,7 +1398,7 @@ module Aws::CodeCatalyst
     # @option params [required, String] :space_name
     #   The name of the space.
     #
-    # @option params [required, String] :project_name
+    # @option params [String] :project_name
     #   The name of the project in the space.
     #
     # @option params [Array<Types::Filter>] :filters
@@ -1316,7 +1426,7 @@ module Aws::CodeCatalyst
     #
     #   resp = client.list_dev_environments({
     #     space_name: "NameString", # required
-    #     project_name: "NameString", # required
+    #     project_name: "NameString",
     #     filters: [
     #       {
     #         key: "String", # required
@@ -1359,9 +1469,26 @@ module Aws::CodeCatalyst
       req.send_request(options)
     end
 
-    # Retrieves a list of events that occurred during a specified time
-    # period in a space. You can use these events to audit user and system
-    # activity in a space.
+    # Retrieves a list of events that occurred during a specific time in a
+    # space. You can use these events to audit user and system activity in a
+    # space. For more information, see [Monitoring][1] in the *Amazon
+    # CodeCatalyst User Guide*.
+    #
+    # <note markdown="1"> ListEventLogs guarantees events for the last 30 days in a given space.
+    # You can also view and retrieve a list of management events over the
+    # last 90 days for Amazon CodeCatalyst in the CloudTrail console by
+    # viewing Event history, or by creating a trail to create and maintain a
+    # record of events that extends past 90 days. For more information, see
+    # [Working with CloudTrail Event History][2] and [Working with
+    # CloudTrail trails][3].
+    #
+    #  </note>
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/codecatalyst/latest/userguide/ipa-monitoring.html
+    # [2]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/view-cloudtrail-events.html
+    # [3]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-getting-started.html
     #
     # @option params [required, String] :space_name
     #   The name of the space.
@@ -1484,9 +1611,9 @@ module Aws::CodeCatalyst
     #     max_results: 1,
     #     filters: [
     #       {
-    #         key: "hasAccessTo", # required, accepts hasAccessTo
+    #         key: "hasAccessTo", # required, accepts hasAccessTo, name
     #         values: ["String"], # required
-    #         comparison_operator: "EQ", # accepts EQ, GT, GE, LT, LE
+    #         comparison_operator: "EQ", # accepts EQ, GT, GE, LT, LE, BEGINS_WITH
     #       },
     #     ],
     #   })
@@ -1654,6 +1781,138 @@ module Aws::CodeCatalyst
       req.send_request(options)
     end
 
+    # Retrieves a list of workflow runs of a specified workflow.
+    #
+    # @option params [required, String] :space_name
+    #   The name of the space.
+    #
+    # @option params [String] :workflow_id
+    #   The ID of the workflow. To retrieve a list of workflow IDs, use
+    #   ListWorkflows.
+    #
+    # @option params [required, String] :project_name
+    #   The name of the project in the space.
+    #
+    # @option params [String] :next_token
+    #   A token returned from a call to this API to indicate the next batch of
+    #   results to return, if any.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of results to show in a single call to this API. If
+    #   the number of results is larger than the number you specified, the
+    #   response will include a `NextToken` element, which you can use to
+    #   obtain additional results.
+    #
+    # @option params [Array<Types::WorkflowRunSortCriteria>] :sort_by
+    #   Information used to sort the items in the returned list.
+    #
+    # @return [Types::ListWorkflowRunsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListWorkflowRunsResponse#next_token #next_token} => String
+    #   * {Types::ListWorkflowRunsResponse#items #items} => Array&lt;Types::WorkflowRunSummary&gt;
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_workflow_runs({
+    #     space_name: "NameString", # required
+    #     workflow_id: "Uuid",
+    #     project_name: "ListWorkflowRunsRequestProjectNameString", # required
+    #     next_token: "ListWorkflowRunsRequestNextTokenString",
+    #     max_results: 1,
+    #     sort_by: [
+    #       {
+    #       },
+    #     ],
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.next_token #=> String
+    #   resp.items #=> Array
+    #   resp.items[0].id #=> String
+    #   resp.items[0].workflow_id #=> String
+    #   resp.items[0].workflow_name #=> String
+    #   resp.items[0].status #=> String, one of "SUCCEEDED", "FAILED", "STOPPED", "SUPERSEDED", "CANCELLED", "NOT_RUN", "VALIDATING", "PROVISIONING", "IN_PROGRESS", "STOPPING", "ABANDONED"
+    #   resp.items[0].status_reasons #=> Array
+    #   resp.items[0].start_time #=> Time
+    #   resp.items[0].end_time #=> Time
+    #   resp.items[0].last_updated_time #=> Time
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/codecatalyst-2022-09-28/ListWorkflowRuns AWS API Documentation
+    #
+    # @overload list_workflow_runs(params = {})
+    # @param [Hash] params ({})
+    def list_workflow_runs(params = {}, options = {})
+      req = build_request(:list_workflow_runs, params)
+      req.send_request(options)
+    end
+
+    # Retrieves a list of workflows in a specified project.
+    #
+    # @option params [required, String] :space_name
+    #   The name of the space.
+    #
+    # @option params [required, String] :project_name
+    #   The name of the project in the space.
+    #
+    # @option params [String] :next_token
+    #   A token returned from a call to this API to indicate the next batch of
+    #   results to return, if any.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of results to show in a single call to this API. If
+    #   the number of results is larger than the number you specified, the
+    #   response will include a `NextToken` element, which you can use to
+    #   obtain additional results.
+    #
+    # @option params [Array<Types::WorkflowSortCriteria>] :sort_by
+    #   Information used to sort the items in the returned list.
+    #
+    # @return [Types::ListWorkflowsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListWorkflowsResponse#next_token #next_token} => String
+    #   * {Types::ListWorkflowsResponse#items #items} => Array&lt;Types::WorkflowSummary&gt;
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_workflows({
+    #     space_name: "ListWorkflowsRequestSpaceNameString", # required
+    #     project_name: "NameString", # required
+    #     next_token: "ListWorkflowsRequestNextTokenString",
+    #     max_results: 1,
+    #     sort_by: [
+    #       {
+    #       },
+    #     ],
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.next_token #=> String
+    #   resp.items #=> Array
+    #   resp.items[0].id #=> String
+    #   resp.items[0].name #=> String
+    #   resp.items[0].source_repository_name #=> String
+    #   resp.items[0].source_branch_name #=> String
+    #   resp.items[0].definition.path #=> String
+    #   resp.items[0].created_time #=> Time
+    #   resp.items[0].last_updated_time #=> Time
+    #   resp.items[0].run_mode #=> String, one of "QUEUED", "PARALLEL", "SUPERSEDED"
+    #   resp.items[0].status #=> String, one of "INVALID", "ACTIVE"
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/codecatalyst-2022-09-28/ListWorkflows AWS API Documentation
+    #
+    # @overload list_workflows(params = {})
+    # @param [Hash] params ({})
+    def list_workflows(params = {}, options = {})
+      req = build_request(:list_workflows, params)
+      req.send_request(options)
+    end
+
     # Starts a specified Dev Environment and puts it into an active state.
     #
     # @option params [required, String] :space_name
@@ -1771,6 +2030,60 @@ module Aws::CodeCatalyst
       req.send_request(options)
     end
 
+    # Begins a run of a specified workflow.
+    #
+    # @option params [required, String] :space_name
+    #   The name of the space.
+    #
+    # @option params [required, String] :project_name
+    #   The name of the project in the space.
+    #
+    # @option params [required, String] :workflow_id
+    #   The system-generated unique ID of the workflow. To retrieve a list of
+    #   workflow IDs, use ListWorkflows.
+    #
+    # @option params [String] :client_token
+    #   A user-specified idempotency token. Idempotency ensures that an API
+    #   request completes only once. With an idempotent request, if the
+    #   original request completes successfully, the subsequent retries return
+    #   the result from the original successful request and have no additional
+    #   effect.
+    #
+    #   **A suitable default value is auto-generated.** You should normally
+    #   not need to pass this option.**
+    #
+    # @return [Types::StartWorkflowRunResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::StartWorkflowRunResponse#space_name #space_name} => String
+    #   * {Types::StartWorkflowRunResponse#project_name #project_name} => String
+    #   * {Types::StartWorkflowRunResponse#id #id} => String
+    #   * {Types::StartWorkflowRunResponse#workflow_id #workflow_id} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.start_workflow_run({
+    #     space_name: "StartWorkflowRunRequestSpaceNameString", # required
+    #     project_name: "StartWorkflowRunRequestProjectNameString", # required
+    #     workflow_id: "Uuid", # required
+    #     client_token: "StartWorkflowRunRequestClientTokenString",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.space_name #=> String
+    #   resp.project_name #=> String
+    #   resp.id #=> String
+    #   resp.workflow_id #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/codecatalyst-2022-09-28/StartWorkflowRun AWS API Documentation
+    #
+    # @overload start_workflow_run(params = {})
+    # @param [Hash] params ({})
+    def start_workflow_run(params = {}, options = {})
+      req = build_request(:start_workflow_run, params)
+      req.send_request(options)
+    end
+
     # Pauses a specified Dev Environment and places it in a non-running
     # state. Stopped Dev Environments do not consume compute minutes.
     #
@@ -2070,7 +2383,7 @@ module Aws::CodeCatalyst
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-codecatalyst'
-      context[:gem_version] = '1.11.0'
+      context[:gem_version] = '1.12.0'
       Seahorse::Client::Request.new(handlers, context)
     end