lib/aws-sdk-wellarchitected/client.rb in aws-sdk-wellarchitected-1.33.0 vs lib/aws-sdk-wellarchitected/client.rb in aws-sdk-wellarchitected-1.34.0
- old
+ new
@@ -1127,10 +1127,13 @@
# The list of profile ARNs associated with the workload.
#
# @option params [Array<String>] :review_template_arns
# The list of review template ARNs to associate with the workload.
#
+ # @option params [Types::WorkloadJiraConfigurationInput] :jira_configuration
+ # Jira configuration settings when creating a workload.
+ #
# @return [Types::CreateWorkloadOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CreateWorkloadOutput#workload_id #workload_id} => String
# * {Types::CreateWorkloadOutput#workload_arn #workload_arn} => String
#
@@ -1159,10 +1162,15 @@
# workload_resource_definition: ["WORKLOAD_METADATA"], # accepts WORKLOAD_METADATA, APP_REGISTRY
# },
# applications: ["ApplicationArn"],
# profile_arns: ["ProfileArn"],
# review_template_arns: ["TemplateArn"],
+ # jira_configuration: {
+ # issue_management_status: "ENABLED", # accepts ENABLED, DISABLED, INHERIT
+ # issue_management_type: "AUTO", # accepts AUTO, MANUAL
+ # jira_project_key: "JiraProjectKey",
+ # },
# })
#
# @example Response structure
#
# resp.workload_id #=> String
@@ -1880,10 +1888,12 @@
# resp.answer.choice_answers[0].notes #=> String
# resp.answer.is_applicable #=> Boolean
# resp.answer.risk #=> String, one of "UNANSWERED", "HIGH", "MEDIUM", "NONE", "NOT_APPLICABLE"
# resp.answer.notes #=> String
# resp.answer.reason #=> String, one of "OUT_OF_SCOPE", "BUSINESS_PRIORITIES", "ARCHITECTURE_CONSTRAINTS", "OTHER", "NONE"
+ # resp.answer.jira_configuration.jira_issue_url #=> String
+ # resp.answer.jira_configuration.last_synced_time #=> Time
#
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetAnswer AWS API Documentation
#
# @overload get_answer(params = {})
# @param [Hash] params ({})
@@ -1964,10 +1974,38 @@
def get_consolidated_report(params = {}, options = {})
req = build_request(:get_consolidated_report, params)
req.send_request(options)
end
+ # Global settings for all workloads.
+ #
+ # @return [Types::GetGlobalSettingsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::GetGlobalSettingsOutput#organization_sharing_status #organization_sharing_status} => String
+ # * {Types::GetGlobalSettingsOutput#discovery_integration_status #discovery_integration_status} => String
+ # * {Types::GetGlobalSettingsOutput#jira_configuration #jira_configuration} => Types::AccountJiraConfigurationOutput
+ #
+ # @example Response structure
+ #
+ # resp.organization_sharing_status #=> String, one of "ENABLED", "DISABLED"
+ # resp.discovery_integration_status #=> String, one of "ENABLED", "DISABLED"
+ # resp.jira_configuration.integration_status #=> String, one of "CONFIGURED", "NOT_CONFIGURED"
+ # resp.jira_configuration.issue_management_status #=> String, one of "ENABLED", "DISABLED"
+ # resp.jira_configuration.issue_management_type #=> String, one of "AUTO", "MANUAL"
+ # resp.jira_configuration.subdomain #=> String
+ # resp.jira_configuration.jira_project_key #=> String
+ # resp.jira_configuration.status_message #=> String
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetGlobalSettings AWS API Documentation
+ #
+ # @overload get_global_settings(params = {})
+ # @param [Hash] params ({})
+ def get_global_settings(params = {}, options = {})
+ req = build_request(:get_global_settings, params)
+ req.send_request(options)
+ end
+
# Get an existing lens.
#
# @option params [required, String] :lens_alias
# The alias of the lens.
#
@@ -2070,10 +2108,14 @@
# resp.lens_review.pillar_review_summaries[0].notes #=> String
# resp.lens_review.pillar_review_summaries[0].risk_counts #=> Hash
# resp.lens_review.pillar_review_summaries[0].risk_counts["Risk"] #=> Integer
# resp.lens_review.pillar_review_summaries[0].prioritized_risk_counts #=> Hash
# resp.lens_review.pillar_review_summaries[0].prioritized_risk_counts["Risk"] #=> Integer
+ # resp.lens_review.jira_configuration.selected_pillars #=> Array
+ # resp.lens_review.jira_configuration.selected_pillars[0].pillar_id #=> String
+ # resp.lens_review.jira_configuration.selected_pillars[0].selected_question_ids #=> Array
+ # resp.lens_review.jira_configuration.selected_pillars[0].selected_question_ids[0] #=> String
# resp.lens_review.updated_at #=> Time
# resp.lens_review.notes #=> String
# resp.lens_review.risk_counts #=> Hash
# resp.lens_review.risk_counts["Risk"] #=> Integer
# resp.lens_review.next_token #=> String
@@ -2279,10 +2321,14 @@
# resp.milestone.workload.profiles #=> Array
# resp.milestone.workload.profiles[0].profile_arn #=> String
# resp.milestone.workload.profiles[0].profile_version #=> String
# resp.milestone.workload.prioritized_risk_counts #=> Hash
# resp.milestone.workload.prioritized_risk_counts["Risk"] #=> Integer
+ # resp.milestone.workload.jira_configuration.issue_management_status #=> String, one of "ENABLED", "DISABLED", "INHERIT"
+ # resp.milestone.workload.jira_configuration.issue_management_type #=> String, one of "AUTO", "MANUAL"
+ # resp.milestone.workload.jira_configuration.jira_project_key #=> String
+ # resp.milestone.workload.jira_configuration.status_message #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetMilestone AWS API Documentation
#
# @overload get_milestone(params = {})
# @param [Hash] params ({})
@@ -2613,10 +2659,14 @@
# resp.workload.profiles #=> Array
# resp.workload.profiles[0].profile_arn #=> String
# resp.workload.profiles[0].profile_version #=> String
# resp.workload.prioritized_risk_counts #=> Hash
# resp.workload.prioritized_risk_counts["Risk"] #=> Integer
+ # resp.workload.jira_configuration.issue_management_status #=> String, one of "ENABLED", "DISABLED", "INHERIT"
+ # resp.workload.jira_configuration.issue_management_type #=> String, one of "AUTO", "MANUAL"
+ # resp.workload.jira_configuration.jira_project_key #=> String
+ # resp.workload.jira_configuration.status_message #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetWorkload AWS API Documentation
#
# @overload get_workload(params = {})
# @param [Hash] params ({})
@@ -2815,10 +2865,12 @@
# resp.answer_summaries[0].choice_answer_summaries[0].reason #=> String, one of "OUT_OF_SCOPE", "BUSINESS_PRIORITIES", "ARCHITECTURE_CONSTRAINTS", "OTHER", "NONE"
# resp.answer_summaries[0].is_applicable #=> Boolean
# resp.answer_summaries[0].risk #=> String, one of "UNANSWERED", "HIGH", "MEDIUM", "NONE", "NOT_APPLICABLE"
# resp.answer_summaries[0].reason #=> String, one of "OUT_OF_SCOPE", "BUSINESS_PRIORITIES", "ARCHITECTURE_CONSTRAINTS", "OTHER", "NONE"
# resp.answer_summaries[0].question_type #=> String, one of "PRIORITIZED", "NON_PRIORITIZED"
+ # resp.answer_summaries[0].jira_configuration.jira_issue_url #=> String
+ # resp.answer_summaries[0].jira_configuration.last_synced_time #=> Time
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListAnswers AWS API Documentation
#
# @overload list_answers(params = {})
@@ -2971,11 +3023,11 @@
def list_check_summaries(params = {}, options = {})
req = build_request(:list_check_summaries, params)
req.send_request(options)
end
- # List lens review improvements.
+ # List the improvements of a particular lens review.
#
# @option params [required, String] :workload_id
# The ID assigned to the workload. This ID is unique within an Amazon
# Web Services Region.
#
@@ -3049,10 +3101,12 @@
# resp.improvement_summaries[0].improvement_plan_url #=> String
# resp.improvement_summaries[0].improvement_plans #=> Array
# resp.improvement_summaries[0].improvement_plans[0].choice_id #=> String
# resp.improvement_summaries[0].improvement_plans[0].display_text #=> String
# resp.improvement_summaries[0].improvement_plans[0].improvement_plan_url #=> String
+ # resp.improvement_summaries[0].jira_configuration.jira_issue_url #=> String
+ # resp.improvement_summaries[0].jira_configuration.last_synced_time #=> Time
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListLensReviewImprovements AWS API Documentation
#
# @overload list_lens_review_improvements(params = {})
@@ -4108,36 +4162,47 @@
# resp.answer.choice_answers[0].notes #=> String
# resp.answer.is_applicable #=> Boolean
# resp.answer.risk #=> String, one of "UNANSWERED", "HIGH", "MEDIUM", "NONE", "NOT_APPLICABLE"
# resp.answer.notes #=> String
# resp.answer.reason #=> String, one of "OUT_OF_SCOPE", "BUSINESS_PRIORITIES", "ARCHITECTURE_CONSTRAINTS", "OTHER", "NONE"
+ # resp.answer.jira_configuration.jira_issue_url #=> String
+ # resp.answer.jira_configuration.last_synced_time #=> Time
#
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateAnswer AWS API Documentation
#
# @overload update_answer(params = {})
# @param [Hash] params ({})
def update_answer(params = {}, options = {})
req = build_request(:update_answer, params)
req.send_request(options)
end
- # Updates whether the Amazon Web Services account is opted into
+ # Update whether the Amazon Web Services account is opted into
# organization sharing and discovery integration features.
#
# @option params [String] :organization_sharing_status
# The status of organization sharing settings.
#
# @option params [String] :discovery_integration_status
# The status of discovery support settings.
#
+ # @option params [Types::AccountJiraConfigurationInput] :jira_configuration
+ # The status of Jira integration settings.
+ #
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.update_global_settings({
# organization_sharing_status: "ENABLED", # accepts ENABLED, DISABLED
# discovery_integration_status: "ENABLED", # accepts ENABLED, DISABLED
+ # jira_configuration: {
+ # issue_management_status: "ENABLED", # accepts ENABLED, DISABLED
+ # issue_management_type: "AUTO", # accepts AUTO, MANUAL
+ # jira_project_key: "JiraProjectKey",
+ # integration_status: "NOT_CONFIGURED", # accepts NOT_CONFIGURED
+ # },
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateGlobalSettings AWS API Documentation
#
# @overload update_global_settings(params = {})
@@ -4145,10 +4210,55 @@
def update_global_settings(params = {}, options = {})
req = build_request(:update_global_settings, params)
req.send_request(options)
end
+ # Update integration features.
+ #
+ # @option params [required, String] :workload_id
+ # The ID assigned to the workload. This ID is unique within an Amazon
+ # Web Services Region.
+ #
+ # @option params [required, String] :client_request_token
+ # A unique case-sensitive string used to ensure that this request is
+ # idempotent (executes only once).
+ #
+ # You should not reuse the same token for other requests. If you retry a
+ # request with the same client request token and the same parameters
+ # after the original request has completed successfully, the result of
+ # the original request is returned.
+ #
+ # This token is listed as required, however, if you do not specify it,
+ # the Amazon Web Services SDKs automatically generate one for you. If
+ # you are not using the Amazon Web Services SDK or the CLI, you must
+ # provide this token or the request will fail.
+ #
+ # **A suitable default value is auto-generated.** You should normally
+ # not need to pass this option.**
+ #
+ # @option params [required, String] :integrating_service
+ # Which integrated service to update.
+ #
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.update_integration({
+ # workload_id: "WorkloadId", # required
+ # client_request_token: "ClientRequestToken", # required
+ # integrating_service: "JIRA", # required, accepts JIRA
+ # })
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateIntegration AWS API Documentation
+ #
+ # @overload update_integration(params = {})
+ # @param [Hash] params ({})
+ def update_integration(params = {}, options = {})
+ req = build_request(:update_integration, params)
+ req.send_request(options)
+ end
+
# Update lens review for a particular workload.
#
# @option params [required, String] :workload_id
# The ID assigned to the workload. This ID is unique within an Amazon
# Web Services Region.
@@ -4177,10 +4287,13 @@
# List of pillar notes of a lens review in a workload.
#
# For a review template, these are the notes that will be associated
# with the workload when the template is applied.
#
+ # @option params [Types::JiraSelectedQuestionConfiguration] :jira_configuration
+ # Configuration of the Jira integration.
+ #
# @return [Types::UpdateLensReviewOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::UpdateLensReviewOutput#workload_id #workload_id} => String
# * {Types::UpdateLensReviewOutput#lens_review #lens_review} => Types::LensReview
#
@@ -4191,10 +4304,18 @@
# lens_alias: "LensAlias", # required
# lens_notes: "Notes",
# pillar_notes: {
# "PillarId" => "Notes",
# },
+ # jira_configuration: {
+ # selected_pillars: [
+ # {
+ # pillar_id: "PillarId",
+ # selected_question_ids: ["SelectedQuestionId"],
+ # },
+ # ],
+ # },
# })
#
# @example Response structure
#
# resp.workload_id #=> String
@@ -4209,10 +4330,14 @@
# resp.lens_review.pillar_review_summaries[0].notes #=> String
# resp.lens_review.pillar_review_summaries[0].risk_counts #=> Hash
# resp.lens_review.pillar_review_summaries[0].risk_counts["Risk"] #=> Integer
# resp.lens_review.pillar_review_summaries[0].prioritized_risk_counts #=> Hash
# resp.lens_review.pillar_review_summaries[0].prioritized_risk_counts["Risk"] #=> Integer
+ # resp.lens_review.jira_configuration.selected_pillars #=> Array
+ # resp.lens_review.jira_configuration.selected_pillars[0].pillar_id #=> String
+ # resp.lens_review.jira_configuration.selected_pillars[0].selected_question_ids #=> Array
+ # resp.lens_review.jira_configuration.selected_pillars[0].selected_question_ids[0] #=> String
# resp.lens_review.updated_at #=> Time
# resp.lens_review.notes #=> String
# resp.lens_review.risk_counts #=> Hash
# resp.lens_review.risk_counts["Risk"] #=> Integer
# resp.lens_review.next_token #=> String
@@ -4717,10 +4842,13 @@
# workload.
#
# @option params [Array<String>] :applications
# List of AppRegistry application ARNs to associate to the workload.
#
+ # @option params [Types::WorkloadJiraConfigurationInput] :jira_configuration
+ # Configuration of the Jira integration.
+ #
# @return [Types::UpdateWorkloadOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::UpdateWorkloadOutput#workload #workload} => Types::Workload
#
# @example Request syntax with placeholder values
@@ -4744,10 +4872,15 @@
# discovery_config: {
# trusted_advisor_integration_status: "ENABLED", # accepts ENABLED, DISABLED
# workload_resource_definition: ["WORKLOAD_METADATA"], # accepts WORKLOAD_METADATA, APP_REGISTRY
# },
# applications: ["ApplicationArn"],
+ # jira_configuration: {
+ # issue_management_status: "ENABLED", # accepts ENABLED, DISABLED, INHERIT
+ # issue_management_type: "AUTO", # accepts AUTO, MANUAL
+ # jira_project_key: "JiraProjectKey",
+ # },
# })
#
# @example Response structure
#
# resp.workload.workload_id #=> String
@@ -4788,10 +4921,14 @@
# resp.workload.profiles #=> Array
# resp.workload.profiles[0].profile_arn #=> String
# resp.workload.profiles[0].profile_version #=> String
# resp.workload.prioritized_risk_counts #=> Hash
# resp.workload.prioritized_risk_counts["Risk"] #=> Integer
+ # resp.workload.jira_configuration.issue_management_status #=> String, one of "ENABLED", "DISABLED", "INHERIT"
+ # resp.workload.jira_configuration.issue_management_type #=> String, one of "AUTO", "MANUAL"
+ # resp.workload.jira_configuration.jira_project_key #=> String
+ # resp.workload.jira_configuration.status_message #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateWorkload AWS API Documentation
#
# @overload update_workload(params = {})
# @param [Hash] params ({})
@@ -5018,10 +5155,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-wellarchitected'
- context[:gem_version] = '1.33.0'
+ context[:gem_version] = '1.34.0'
Seahorse::Client::Request.new(handlers, context)
end
# @api private
# @deprecated