Struct aws_sdk_wellarchitected::Client
source · [−]pub struct Client { /* private fields */ }
Expand description
Client for AWS Well-Architected Tool
Client for invoking operations on AWS Well-Architected Tool. Each operation on AWS Well-Architected Tool is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
Examples
Constructing a client and invoking an operation
// create a shared configuration. This can be used & shared between multiple service clients.
let shared_config = aws_config::load_from_env().await;
let client = aws_sdk_wellarchitected::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */
Constructing a client with custom configuration
use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_wellarchitected::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_wellarchitected::Client::from_conf(config);
Implementations
sourceimpl Client
impl Client
sourcepub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
Creates a client with the given service configuration.
sourceimpl Client
impl Client
sourcepub fn associate_lenses(&self) -> AssociateLenses
pub fn associate_lenses(&self) -> AssociateLenses
Constructs a fluent builder for the AssociateLenses
operation.
- The fluent builder is configurable:
workload_id(impl Into<String>)
/set_workload_id(Option<String>)
:The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
lens_aliases(Vec<String>)
/set_lens_aliases(Option<Vec<String>>)
:List of lens aliases to associate or disassociate with a workload. Up to 10 lenses can be specified.
Identify a lens using its
LensSummary$LensAlias
.
- On success, responds with
AssociateLensesOutput
- On failure, responds with
SdkError<AssociateLensesError>
Constructs a fluent builder for the CreateLensShare
operation.
- The fluent builder is configurable:
lens_alias(impl Into<String>)
/set_lens_alias(Option<String>)
:The alias of the lens, for example,
serverless
.Each lens is identified by its
LensSummary$LensAlias
.shared_with(impl Into<String>)
/set_shared_with(Option<String>)
:The Amazon Web Services account ID or IAM role with which the workload is shared.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
: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 it 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.
- On success, responds with
CreateLensShareOutput
with field(s):share_id(Option<String>)
:The ID associated with the workload share.
- On failure, responds with
SdkError<CreateLensShareError>
sourcepub fn create_lens_version(&self) -> CreateLensVersion
pub fn create_lens_version(&self) -> CreateLensVersion
Constructs a fluent builder for the CreateLensVersion
operation.
- The fluent builder is configurable:
lens_alias(impl Into<String>)
/set_lens_alias(Option<String>)
:The alias of the lens, for example,
serverless
.Each lens is identified by its
LensSummary$LensAlias
.lens_version(impl Into<String>)
/set_lens_version(Option<String>)
:The version of the lens being created.
is_major_version(bool)
/set_is_major_version(bool)
:Set to true if this new major lens version.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
: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 it 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.
- On success, responds with
CreateLensVersionOutput
with field(s):lens_arn(Option<String>)
:The ARN for the lens.
lens_version(Option<String>)
:The version of the lens.
- On failure, responds with
SdkError<CreateLensVersionError>
sourcepub fn create_milestone(&self) -> CreateMilestone
pub fn create_milestone(&self) -> CreateMilestone
Constructs a fluent builder for the CreateMilestone
operation.
- The fluent builder is configurable:
workload_id(impl Into<String>)
/set_workload_id(Option<String>)
:The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
milestone_name(impl Into<String>)
/set_milestone_name(Option<String>)
:The name of the milestone in a workload.
Milestone names must be unique within a workload.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
: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 it 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.
- On success, responds with
CreateMilestoneOutput
with field(s):workload_id(Option<String>)
:The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
milestone_number(i32)
:The milestone number.
A workload can have a maximum of 100 milestones.
- On failure, responds with
SdkError<CreateMilestoneError>
sourcepub fn create_workload(&self) -> CreateWorkload
pub fn create_workload(&self) -> CreateWorkload
Constructs a fluent builder for the CreateWorkload
operation.
- The fluent builder is configurable:
workload_name(impl Into<String>)
/set_workload_name(Option<String>)
:The name of the workload.
The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.
description(impl Into<String>)
/set_description(Option<String>)
:The description for the workload.
environment(WorkloadEnvironment)
/set_environment(Option<WorkloadEnvironment>)
:The environment for the workload.
account_ids(Vec<String>)
/set_account_ids(Option<Vec<String>>)
:The list of Amazon Web Services account IDs associated with the workload.
aws_regions(Vec<String>)
/set_aws_regions(Option<Vec<String>>)
:The list of Amazon Web Services Regions associated with the workload, for example,
us-east-2
, orca-central-1
.non_aws_regions(Vec<String>)
/set_non_aws_regions(Option<Vec<String>>)
:The list of non-Amazon Web Services Regions associated with the workload.
pillar_priorities(Vec<String>)
/set_pillar_priorities(Option<Vec<String>>)
:The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its
PillarReviewSummary$PillarId
.architectural_design(impl Into<String>)
/set_architectural_design(Option<String>)
:The URL of the architectural design for the workload.
review_owner(impl Into<String>)
/set_review_owner(Option<String>)
:The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.
industry_type(impl Into<String>)
/set_industry_type(Option<String>)
:The industry type for the workload.
If specified, must be one of the following:
-
Agriculture
-
Automobile
-
Defense
-
Design and Engineering
-
Digital Advertising
-
Education
-
Environmental Protection
-
Financial Services
-
Gaming
-
General Public Services
-
Healthcare
-
Hospitality
-
InfoTech
-
Justice and Public Safety
-
Life Sciences
-
Manufacturing
-
Media & Entertainment
-
Mining & Resources
-
Oil & Gas
-
Power & Utilities
-
Professional Services
-
Real Estate & Construction
-
Retail & Wholesale
-
Social Protection
-
Telecommunications
-
Travel, Transportation & Logistics
-
Other
-
industry(impl Into<String>)
/set_industry(Option<String>)
:The industry for the workload.
lenses(Vec<String>)
/set_lenses(Option<Vec<String>>)
:The list of lenses associated with the workload. Each lens is identified by its
LensSummary$LensAlias
.notes(impl Into<String>)
/set_notes(Option<String>)
:The notes associated with the workload.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
: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 it 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.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:The tags to be associated with the workload.
- On success, responds with
CreateWorkloadOutput
with field(s):workload_id(Option<String>)
:The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
workload_arn(Option<String>)
:The ARN for the workload.
- On failure, responds with
SdkError<CreateWorkloadError>
Constructs a fluent builder for the CreateWorkloadShare
operation.
- The fluent builder is configurable:
workload_id(impl Into<String>)
/set_workload_id(Option<String>)
:The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
shared_with(impl Into<String>)
/set_shared_with(Option<String>)
:The Amazon Web Services account ID or IAM role with which the workload is shared.
permission_type(PermissionType)
/set_permission_type(Option<PermissionType>)
:Permission granted on a workload share.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
: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 it 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.
- On success, responds with
CreateWorkloadShareOutput
with field(s):workload_id(Option<String>)
:The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
share_id(Option<String>)
:The ID associated with the workload share.
- On failure, responds with
SdkError<CreateWorkloadShareError>
sourcepub fn delete_lens(&self) -> DeleteLens
pub fn delete_lens(&self) -> DeleteLens
Constructs a fluent builder for the DeleteLens
operation.
- The fluent builder is configurable:
lens_alias(impl Into<String>)
/set_lens_alias(Option<String>)
:The alias of the lens, for example,
serverless
.Each lens is identified by its
LensSummary$LensAlias
.client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
: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 it 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.
lens_status(LensStatusType)
/set_lens_status(Option<LensStatusType>)
:The status of the lens to be deleted.
- On success, responds with
DeleteLensOutput
- On failure, responds with
SdkError<DeleteLensError>
Constructs a fluent builder for the DeleteLensShare
operation.
- The fluent builder is configurable:
share_id(impl Into<String>)
/set_share_id(Option<String>)
:The ID associated with the workload share.
lens_alias(impl Into<String>)
/set_lens_alias(Option<String>)
:The alias of the lens, for example,
serverless
.Each lens is identified by its
LensSummary$LensAlias
.client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
: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 it 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.
- On success, responds with
DeleteLensShareOutput
- On failure, responds with
SdkError<DeleteLensShareError>
sourcepub fn delete_workload(&self) -> DeleteWorkload
pub fn delete_workload(&self) -> DeleteWorkload
Constructs a fluent builder for the DeleteWorkload
operation.
- The fluent builder is configurable:
workload_id(impl Into<String>)
/set_workload_id(Option<String>)
:The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
: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 it 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.
- On success, responds with
DeleteWorkloadOutput
- On failure, responds with
SdkError<DeleteWorkloadError>
Constructs a fluent builder for the DeleteWorkloadShare
operation.
- The fluent builder is configurable:
share_id(impl Into<String>)
/set_share_id(Option<String>)
:The ID associated with the workload share.
workload_id(impl Into<String>)
/set_workload_id(Option<String>)
:The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
: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 it 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.
- On success, responds with
DeleteWorkloadShareOutput
- On failure, responds with
SdkError<DeleteWorkloadShareError>
sourcepub fn disassociate_lenses(&self) -> DisassociateLenses
pub fn disassociate_lenses(&self) -> DisassociateLenses
Constructs a fluent builder for the DisassociateLenses
operation.
- The fluent builder is configurable:
workload_id(impl Into<String>)
/set_workload_id(Option<String>)
:The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
lens_aliases(Vec<String>)
/set_lens_aliases(Option<Vec<String>>)
:List of lens aliases to associate or disassociate with a workload. Up to 10 lenses can be specified.
Identify a lens using its
LensSummary$LensAlias
.
- On success, responds with
DisassociateLensesOutput
- On failure, responds with
SdkError<DisassociateLensesError>
sourcepub fn export_lens(&self) -> ExportLens
pub fn export_lens(&self) -> ExportLens
Constructs a fluent builder for the ExportLens
operation.
- The fluent builder is configurable:
lens_alias(impl Into<String>)
/set_lens_alias(Option<String>)
:The alias of the lens, for example,
serverless
.Each lens is identified by its
LensSummary$LensAlias
.lens_version(impl Into<String>)
/set_lens_version(Option<String>)
:The lens version to be exported.
- On success, responds with
ExportLensOutput
with field(s):lens_json(Option<String>)
:The JSON for the lens.
- On failure, responds with
SdkError<ExportLensError>
sourcepub fn get_answer(&self) -> GetAnswer
pub fn get_answer(&self) -> GetAnswer
Constructs a fluent builder for the GetAnswer
operation.
- The fluent builder is configurable:
workload_id(impl Into<String>)
/set_workload_id(Option<String>)
:The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
lens_alias(impl Into<String>)
/set_lens_alias(Option<String>)
:The alias of the lens, for example,
serverless
.Each lens is identified by its
LensSummary$LensAlias
.question_id(impl Into<String>)
/set_question_id(Option<String>)
:The ID of the question.
milestone_number(i32)
/set_milestone_number(i32)
:The milestone number.
A workload can have a maximum of 100 milestones.
- On success, responds with
GetAnswerOutput
with field(s):workload_id(Option<String>)
:The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
milestone_number(i32)
:The milestone number.
A workload can have a maximum of 100 milestones.
lens_alias(Option<String>)
:The alias of the lens, for example,
serverless
.Each lens is identified by its
LensSummary$LensAlias
.lens_arn(Option<String>)
:The ARN for the lens.
answer(Option<Answer>)
:An answer of the question.
- On failure, responds with
SdkError<GetAnswerError>
sourcepub fn get_lens(&self) -> GetLens
pub fn get_lens(&self) -> GetLens
Constructs a fluent builder for the GetLens
operation.
- The fluent builder is configurable:
lens_alias(impl Into<String>)
/set_lens_alias(Option<String>)
:The alias of the lens, for example,
serverless
.Each lens is identified by its
LensSummary$LensAlias
.lens_version(impl Into<String>)
/set_lens_version(Option<String>)
:The lens version to be retrieved.
- On success, responds with
GetLensOutput
with field(s):lens(Option<Lens>)
:A lens return object.
- On failure, responds with
SdkError<GetLensError>
sourcepub fn get_lens_review(&self) -> GetLensReview
pub fn get_lens_review(&self) -> GetLensReview
Constructs a fluent builder for the GetLensReview
operation.
- The fluent builder is configurable:
workload_id(impl Into<String>)
/set_workload_id(Option<String>)
:The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
lens_alias(impl Into<String>)
/set_lens_alias(Option<String>)
:The alias of the lens, for example,
serverless
.Each lens is identified by its
LensSummary$LensAlias
.milestone_number(i32)
/set_milestone_number(i32)
:The milestone number.
A workload can have a maximum of 100 milestones.
- On success, responds with
GetLensReviewOutput
with field(s):workload_id(Option<String>)
:The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
milestone_number(i32)
:The milestone number.
A workload can have a maximum of 100 milestones.
lens_review(Option<LensReview>)
:A lens review of a question.
- On failure, responds with
SdkError<GetLensReviewError>
sourcepub fn get_lens_review_report(&self) -> GetLensReviewReport
pub fn get_lens_review_report(&self) -> GetLensReviewReport
Constructs a fluent builder for the GetLensReviewReport
operation.
- The fluent builder is configurable:
workload_id(impl Into<String>)
/set_workload_id(Option<String>)
:The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
lens_alias(impl Into<String>)
/set_lens_alias(Option<String>)
:The alias of the lens, for example,
serverless
.Each lens is identified by its
LensSummary$LensAlias
.milestone_number(i32)
/set_milestone_number(i32)
:The milestone number.
A workload can have a maximum of 100 milestones.
- On success, responds with
GetLensReviewReportOutput
with field(s):workload_id(Option<String>)
:The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
milestone_number(i32)
:The milestone number.
A workload can have a maximum of 100 milestones.
lens_review_report(Option<LensReviewReport>)
:A report of a lens review.
- On failure, responds with
SdkError<GetLensReviewReportError>
sourcepub fn get_lens_version_difference(&self) -> GetLensVersionDifference
pub fn get_lens_version_difference(&self) -> GetLensVersionDifference
Constructs a fluent builder for the GetLensVersionDifference
operation.
- The fluent builder is configurable:
lens_alias(impl Into<String>)
/set_lens_alias(Option<String>)
:The alias of the lens, for example,
serverless
.Each lens is identified by its
LensSummary$LensAlias
.base_lens_version(impl Into<String>)
/set_base_lens_version(Option<String>)
:The base version of the lens.
target_lens_version(impl Into<String>)
/set_target_lens_version(Option<String>)
:The lens version to target a difference for.
- On success, responds with
GetLensVersionDifferenceOutput
with field(s):lens_alias(Option<String>)
:The alias of the lens, for example,
serverless
.Each lens is identified by its
LensSummary$LensAlias
.lens_arn(Option<String>)
:The ARN for the lens.
base_lens_version(Option<String>)
:The base version of the lens.
target_lens_version(Option<String>)
:The target lens version for the lens.
latest_lens_version(Option<String>)
:The latest version of the lens.
version_differences(Option<VersionDifferences>)
:The differences between the base and latest versions of the lens.
- On failure, responds with
SdkError<GetLensVersionDifferenceError>
sourcepub fn get_milestone(&self) -> GetMilestone
pub fn get_milestone(&self) -> GetMilestone
Constructs a fluent builder for the GetMilestone
operation.
- The fluent builder is configurable:
workload_id(impl Into<String>)
/set_workload_id(Option<String>)
:The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
milestone_number(i32)
/set_milestone_number(i32)
:The milestone number.
A workload can have a maximum of 100 milestones.
- On success, responds with
GetMilestoneOutput
with field(s):workload_id(Option<String>)
:The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
milestone(Option<Milestone>)
:A milestone return object.
- On failure, responds with
SdkError<GetMilestoneError>
sourcepub fn get_workload(&self) -> GetWorkload
pub fn get_workload(&self) -> GetWorkload
Constructs a fluent builder for the GetWorkload
operation.
- The fluent builder is configurable:
workload_id(impl Into<String>)
/set_workload_id(Option<String>)
:The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
- On success, responds with
GetWorkloadOutput
with field(s):workload(Option<Workload>)
:A workload return object.
- On failure, responds with
SdkError<GetWorkloadError>
sourcepub fn import_lens(&self) -> ImportLens
pub fn import_lens(&self) -> ImportLens
Constructs a fluent builder for the ImportLens
operation.
- The fluent builder is configurable:
lens_alias(impl Into<String>)
/set_lens_alias(Option<String>)
:The alias of the lens, for example,
serverless
.Each lens is identified by its
LensSummary$LensAlias
.json_string(impl Into<String>)
/set_json_string(Option<String>)
:The JSON representation of a lens.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
: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 it 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.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:Tags to associate to a lens.
- On success, responds with
ImportLensOutput
with field(s):lens_arn(Option<String>)
:The ARN for the lens.
status(Option<ImportLensStatus>)
:The status of the imported lens.
- On failure, responds with
SdkError<ImportLensError>
sourcepub fn list_answers(&self) -> ListAnswers
pub fn list_answers(&self) -> ListAnswers
Constructs a fluent builder for the ListAnswers
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
workload_id(impl Into<String>)
/set_workload_id(Option<String>)
:The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
lens_alias(impl Into<String>)
/set_lens_alias(Option<String>)
:The alias of the lens, for example,
serverless
.Each lens is identified by its
LensSummary$LensAlias
.pillar_id(impl Into<String>)
/set_pillar_id(Option<String>)
:The ID used to identify a pillar, for example,
security
.A pillar is identified by its
PillarReviewSummary$PillarId
.milestone_number(i32)
/set_milestone_number(i32)
:The milestone number.
A workload can have a maximum of 100 milestones.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to use to retrieve the next set of results.
max_results(i32)
/set_max_results(i32)
:The maximum number of results to return for this request.
- On success, responds with
ListAnswersOutput
with field(s):workload_id(Option<String>)
:The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
milestone_number(i32)
:The milestone number.
A workload can have a maximum of 100 milestones.
lens_alias(Option<String>)
:The alias of the lens, for example,
serverless
.Each lens is identified by its
LensSummary$LensAlias
.lens_arn(Option<String>)
:The ARN for the lens.
answer_summaries(Option<Vec<AnswerSummary>>)
:List of answer summaries of lens review in a workload.
next_token(Option<String>)
:The token to use to retrieve the next set of results.
- On failure, responds with
SdkError<ListAnswersError>
sourcepub fn list_lenses(&self) -> ListLenses
pub fn list_lenses(&self) -> ListLenses
Constructs a fluent builder for the ListLenses
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to use to retrieve the next set of results.
max_results(i32)
/set_max_results(i32)
:The maximum number of results to return for this request.
lens_type(LensType)
/set_lens_type(Option<LensType>)
:The type of lenses to be returned.
lens_status(LensStatusType)
/set_lens_status(Option<LensStatusType>)
:The status of lenses to be returned.
lens_name(impl Into<String>)
/set_lens_name(Option<String>)
:The full name of the lens.
- On success, responds with
ListLensesOutput
with field(s):lens_summaries(Option<Vec<LensSummary>>)
:List of lens summaries of available lenses.
next_token(Option<String>)
:The token to use to retrieve the next set of results.
- On failure, responds with
SdkError<ListLensesError>
sourcepub fn list_lens_review_improvements(&self) -> ListLensReviewImprovements
pub fn list_lens_review_improvements(&self) -> ListLensReviewImprovements
Constructs a fluent builder for the ListLensReviewImprovements
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
workload_id(impl Into<String>)
/set_workload_id(Option<String>)
:The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
lens_alias(impl Into<String>)
/set_lens_alias(Option<String>)
:The alias of the lens, for example,
serverless
.Each lens is identified by its
LensSummary$LensAlias
.pillar_id(impl Into<String>)
/set_pillar_id(Option<String>)
:The ID used to identify a pillar, for example,
security
.A pillar is identified by its
PillarReviewSummary$PillarId
.milestone_number(i32)
/set_milestone_number(i32)
:The milestone number.
A workload can have a maximum of 100 milestones.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to use to retrieve the next set of results.
max_results(i32)
/set_max_results(i32)
:The maximum number of results to return for this request.
- On success, responds with
ListLensReviewImprovementsOutput
with field(s):workload_id(Option<String>)
:The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
milestone_number(i32)
:The milestone number.
A workload can have a maximum of 100 milestones.
lens_alias(Option<String>)
:The alias of the lens, for example,
serverless
.Each lens is identified by its
LensSummary$LensAlias
.lens_arn(Option<String>)
:The ARN for the lens.
improvement_summaries(Option<Vec<ImprovementSummary>>)
:List of improvement summaries of lens review in a workload.
next_token(Option<String>)
:The token to use to retrieve the next set of results.
- On failure, responds with
SdkError<ListLensReviewImprovementsError>
sourcepub fn list_lens_reviews(&self) -> ListLensReviews
pub fn list_lens_reviews(&self) -> ListLensReviews
Constructs a fluent builder for the ListLensReviews
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
workload_id(impl Into<String>)
/set_workload_id(Option<String>)
:The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
milestone_number(i32)
/set_milestone_number(i32)
:The milestone number.
A workload can have a maximum of 100 milestones.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to use to retrieve the next set of results.
max_results(i32)
/set_max_results(i32)
:The maximum number of results to return for this request.
- On success, responds with
ListLensReviewsOutput
with field(s):workload_id(Option<String>)
:The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
milestone_number(i32)
:The milestone number.
A workload can have a maximum of 100 milestones.
lens_review_summaries(Option<Vec<LensReviewSummary>>)
:List of lens summaries of lens reviews of a workload.
next_token(Option<String>)
:The token to use to retrieve the next set of results.
- On failure, responds with
SdkError<ListLensReviewsError>
Constructs a fluent builder for the ListLensShares
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
lens_alias(impl Into<String>)
/set_lens_alias(Option<String>)
:The alias of the lens, for example,
serverless
.Each lens is identified by its
LensSummary$LensAlias
.shared_with_prefix(impl Into<String>)
/set_shared_with_prefix(Option<String>)
:The Amazon Web Services account ID or IAM role with which the lens is shared.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to use to retrieve the next set of results.
max_results(i32)
/set_max_results(i32)
:The maximum number of results to return for this request.
- On success, responds with
ListLensSharesOutput
with field(s):lens_share_summaries(Option<Vec<LensShareSummary>>)
:A list of lens share summaries.
next_token(Option<String>)
:The token to use to retrieve the next set of results.
- On failure, responds with
SdkError<ListLensSharesError>
sourcepub fn list_milestones(&self) -> ListMilestones
pub fn list_milestones(&self) -> ListMilestones
Constructs a fluent builder for the ListMilestones
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
workload_id(impl Into<String>)
/set_workload_id(Option<String>)
:The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to use to retrieve the next set of results.
max_results(i32)
/set_max_results(i32)
:The maximum number of results to return for this request.
- On success, responds with
ListMilestonesOutput
with field(s):workload_id(Option<String>)
:The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
milestone_summaries(Option<Vec<MilestoneSummary>>)
:A list of milestone summaries.
next_token(Option<String>)
:The token to use to retrieve the next set of results.
- On failure, responds with
SdkError<ListMilestonesError>
sourcepub fn list_notifications(&self) -> ListNotifications
pub fn list_notifications(&self) -> ListNotifications
Constructs a fluent builder for the ListNotifications
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
workload_id(impl Into<String>)
/set_workload_id(Option<String>)
:The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to use to retrieve the next set of results.
max_results(i32)
/set_max_results(i32)
:The maximum number of results to return for this request.
- On success, responds with
ListNotificationsOutput
with field(s):notification_summaries(Option<Vec<NotificationSummary>>)
:List of lens notification summaries in a workload.
next_token(Option<String>)
:The token to use to retrieve the next set of results.
- On failure, responds with
SdkError<ListNotificationsError>
Constructs a fluent builder for the ListShareInvitations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
workload_name_prefix(impl Into<String>)
/set_workload_name_prefix(Option<String>)
:An optional string added to the beginning of each workload name returned in the results.
lens_name_prefix(impl Into<String>)
/set_lens_name_prefix(Option<String>)
:An optional string added to the beginning of each lens name returned in the results.
share_resource_type(ShareResourceType)
/set_share_resource_type(Option<ShareResourceType>)
:The type of share invitations to be returned.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to use to retrieve the next set of results.
max_results(i32)
/set_max_results(i32)
:The maximum number of results to return for this request.
- On success, responds with
ListShareInvitationsOutput
with field(s):share_invitation_summaries(Option<Vec<ShareInvitationSummary>>)
:List of share invitation summaries in a workload.
next_token(Option<String>)
:The token to use to retrieve the next set of results.
- On failure, responds with
SdkError<ListShareInvitationsError>
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
workload_arn(impl Into<String>)
/set_workload_arn(Option<String>)
:The ARN for the workload.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<HashMap<String, String>>)
:The tags for the resource.
- On failure, responds with
SdkError<ListTagsForResourceError>
sourcepub fn list_workloads(&self) -> ListWorkloads
pub fn list_workloads(&self) -> ListWorkloads
Constructs a fluent builder for the ListWorkloads
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
workload_name_prefix(impl Into<String>)
/set_workload_name_prefix(Option<String>)
:An optional string added to the beginning of each workload name returned in the results.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to use to retrieve the next set of results.
max_results(i32)
/set_max_results(i32)
:The maximum number of results to return for this request.
- On success, responds with
ListWorkloadsOutput
with field(s):workload_summaries(Option<Vec<WorkloadSummary>>)
:A list of workload summaries.
next_token(Option<String>)
:The token to use to retrieve the next set of results.
- On failure, responds with
SdkError<ListWorkloadsError>
Constructs a fluent builder for the ListWorkloadShares
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
workload_id(impl Into<String>)
/set_workload_id(Option<String>)
:The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
shared_with_prefix(impl Into<String>)
/set_shared_with_prefix(Option<String>)
:The Amazon Web Services account ID or IAM role with which the workload is shared.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to use to retrieve the next set of results.
max_results(i32)
/set_max_results(i32)
:The maximum number of results to return for this request.
- On success, responds with
ListWorkloadSharesOutput
with field(s):workload_id(Option<String>)
:The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
workload_share_summaries(Option<Vec<WorkloadShareSummary>>)
:A list of workload share summaries.
next_token(Option<String>)
:The token to use to retrieve the next set of results.
- On failure, responds with
SdkError<ListWorkloadSharesError>
sourcepub fn tag_resource(&self) -> TagResource
pub fn tag_resource(&self) -> TagResource
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
workload_arn(impl Into<String>)
/set_workload_arn(Option<String>)
:The ARN for the workload.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:The tags for the resource.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
sourcepub fn untag_resource(&self) -> UntagResource
pub fn untag_resource(&self) -> UntagResource
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
workload_arn(impl Into<String>)
/set_workload_arn(Option<String>)
:The ARN for the workload.
tag_keys(Vec<String>)
/set_tag_keys(Option<Vec<String>>)
:A list of tag keys. Existing tags of the resource whose keys are members of this list are removed from the resource.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
sourcepub fn update_answer(&self) -> UpdateAnswer
pub fn update_answer(&self) -> UpdateAnswer
Constructs a fluent builder for the UpdateAnswer
operation.
- The fluent builder is configurable:
workload_id(impl Into<String>)
/set_workload_id(Option<String>)
:The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
lens_alias(impl Into<String>)
/set_lens_alias(Option<String>)
:The alias of the lens, for example,
serverless
.Each lens is identified by its
LensSummary$LensAlias
.question_id(impl Into<String>)
/set_question_id(Option<String>)
:The ID of the question.
selected_choices(Vec<String>)
/set_selected_choices(Option<Vec<String>>)
:List of selected choice IDs in a question answer.
The values entered replace the previously selected choices.
choice_updates(HashMap<String, ChoiceUpdate>)
/set_choice_updates(Option<HashMap<String, ChoiceUpdate>>)
:A list of choices to update on a question in your workload. The String key corresponds to the choice ID to be updated.
notes(impl Into<String>)
/set_notes(Option<String>)
:The notes associated with the workload.
is_applicable(bool)
/set_is_applicable(bool)
:Defines whether this question is applicable to a lens review.
reason(AnswerReason)
/set_reason(Option<AnswerReason>)
:The reason why a question is not applicable to your workload.
- On success, responds with
UpdateAnswerOutput
with field(s):workload_id(Option<String>)
:The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
lens_alias(Option<String>)
:The alias of the lens, for example,
serverless
.Each lens is identified by its
LensSummary$LensAlias
.lens_arn(Option<String>)
:The ARN for the lens.
answer(Option<Answer>)
:An answer of the question.
- On failure, responds with
SdkError<UpdateAnswerError>
sourcepub fn update_lens_review(&self) -> UpdateLensReview
pub fn update_lens_review(&self) -> UpdateLensReview
Constructs a fluent builder for the UpdateLensReview
operation.
- The fluent builder is configurable:
workload_id(impl Into<String>)
/set_workload_id(Option<String>)
:The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
lens_alias(impl Into<String>)
/set_lens_alias(Option<String>)
:The alias of the lens, for example,
serverless
.Each lens is identified by its
LensSummary$LensAlias
.lens_notes(impl Into<String>)
/set_lens_notes(Option<String>)
:The notes associated with the workload.
pillar_notes(HashMap<String, String>)
/set_pillar_notes(Option<HashMap<String, String>>)
:List of pillar notes of a lens review in a workload.
- On success, responds with
UpdateLensReviewOutput
with field(s):workload_id(Option<String>)
:The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
lens_review(Option<LensReview>)
:A lens review of a question.
- On failure, responds with
SdkError<UpdateLensReviewError>
Constructs a fluent builder for the UpdateShareInvitation
operation.
- The fluent builder is configurable:
share_invitation_id(impl Into<String>)
/set_share_invitation_id(Option<String>)
:The ID assigned to the share invitation.
share_invitation_action(ShareInvitationAction)
/set_share_invitation_action(Option<ShareInvitationAction>)
:Share invitation action taken by contributor.
- On success, responds with
UpdateShareInvitationOutput
with field(s):share_invitation(Option<ShareInvitation>)
:The updated workload share invitation.
- On failure, responds with
SdkError<UpdateShareInvitationError>
sourcepub fn update_workload(&self) -> UpdateWorkload
pub fn update_workload(&self) -> UpdateWorkload
Constructs a fluent builder for the UpdateWorkload
operation.
- The fluent builder is configurable:
workload_id(impl Into<String>)
/set_workload_id(Option<String>)
:The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
workload_name(impl Into<String>)
/set_workload_name(Option<String>)
:The name of the workload.
The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.
description(impl Into<String>)
/set_description(Option<String>)
:The description for the workload.
environment(WorkloadEnvironment)
/set_environment(Option<WorkloadEnvironment>)
:The environment for the workload.
account_ids(Vec<String>)
/set_account_ids(Option<Vec<String>>)
:The list of Amazon Web Services account IDs associated with the workload.
aws_regions(Vec<String>)
/set_aws_regions(Option<Vec<String>>)
:The list of Amazon Web Services Regions associated with the workload, for example,
us-east-2
, orca-central-1
.non_aws_regions(Vec<String>)
/set_non_aws_regions(Option<Vec<String>>)
:The list of non-Amazon Web Services Regions associated with the workload.
pillar_priorities(Vec<String>)
/set_pillar_priorities(Option<Vec<String>>)
:The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its
PillarReviewSummary$PillarId
.architectural_design(impl Into<String>)
/set_architectural_design(Option<String>)
:The URL of the architectural design for the workload.
review_owner(impl Into<String>)
/set_review_owner(Option<String>)
:The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.
is_review_owner_update_acknowledged(bool)
/set_is_review_owner_update_acknowledged(bool)
:Flag indicating whether the workload owner has acknowledged that the Review owner field is required.
If a Review owner is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added.
industry_type(impl Into<String>)
/set_industry_type(Option<String>)
:The industry type for the workload.
If specified, must be one of the following:
-
Agriculture
-
Automobile
-
Defense
-
Design and Engineering
-
Digital Advertising
-
Education
-
Environmental Protection
-
Financial Services
-
Gaming
-
General Public Services
-
Healthcare
-
Hospitality
-
InfoTech
-
Justice and Public Safety
-
Life Sciences
-
Manufacturing
-
Media & Entertainment
-
Mining & Resources
-
Oil & Gas
-
Power & Utilities
-
Professional Services
-
Real Estate & Construction
-
Retail & Wholesale
-
Social Protection
-
Telecommunications
-
Travel, Transportation & Logistics
-
Other
-
industry(impl Into<String>)
/set_industry(Option<String>)
:The industry for the workload.
notes(impl Into<String>)
/set_notes(Option<String>)
:The notes associated with the workload.
improvement_status(WorkloadImprovementStatus)
/set_improvement_status(Option<WorkloadImprovementStatus>)
:The improvement status for a workload.
- On success, responds with
UpdateWorkloadOutput
with field(s):workload(Option<Workload>)
:A workload return object.
- On failure, responds with
SdkError<UpdateWorkloadError>
Constructs a fluent builder for the UpdateWorkloadShare
operation.
- The fluent builder is configurable:
share_id(impl Into<String>)
/set_share_id(Option<String>)
:The ID associated with the workload share.
workload_id(impl Into<String>)
/set_workload_id(Option<String>)
:The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
permission_type(PermissionType)
/set_permission_type(Option<PermissionType>)
:Permission granted on a workload share.
- On success, responds with
UpdateWorkloadShareOutput
with field(s):workload_id(Option<String>)
:The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
workload_share(Option<WorkloadShare>)
:A workload share return object.
- On failure, responds with
SdkError<UpdateWorkloadShareError>
sourcepub fn upgrade_lens_review(&self) -> UpgradeLensReview
pub fn upgrade_lens_review(&self) -> UpgradeLensReview
Constructs a fluent builder for the UpgradeLensReview
operation.
- The fluent builder is configurable:
workload_id(impl Into<String>)
/set_workload_id(Option<String>)
:The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
lens_alias(impl Into<String>)
/set_lens_alias(Option<String>)
:The alias of the lens, for example,
serverless
.Each lens is identified by its
LensSummary$LensAlias
.milestone_name(impl Into<String>)
/set_milestone_name(Option<String>)
:The name of the milestone in a workload.
Milestone names must be unique within a workload.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
: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 it 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.
- On success, responds with
UpgradeLensReviewOutput
- On failure, responds with
SdkError<UpgradeLensReviewError>
sourceimpl Client
impl Client
sourcepub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
pub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
Creates a client with the given service config and connector override.
Trait Implementations
sourceimpl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
sourcefn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
Converts to this type from the input type.
Auto Trait Implementations
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more