Struct Client 

pub struct Client { /* private fields */ }

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.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_wellarchitected::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_wellarchitected::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the AssociateLenses operation has a Client::associate_lenses, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.associate_lenses()
    .workload_id("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn associate_lenses(&self) -> AssociateLensesFluentBuilder

Constructs a fluent builder for the AssociateLenses operation.

• The fluent builder is configurable:
  • workload_id(impl Into<String>) / set_workload_id(Option<String>):
    required: true
    

    The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

    
    
  • lens_aliases(impl Into<String>) / set_lens_aliases(Option<Vec::<String>>):
    required: true
    

    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>

impl Client

pub fn associate_profiles(&self) -> AssociateProfilesFluentBuilder

Constructs a fluent builder for the AssociateProfiles operation.

• The fluent builder is configurable:
  • workload_id(impl Into<String>) / set_workload_id(Option<String>):
    required: true
    

    The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

    
    
  • profile_arns(impl Into<String>) / set_profile_arns(Option<Vec::<String>>):
    required: true
    

    The list of profile ARNs to associate with the workload.

    
    
• On success, responds with AssociateProfilesOutput
• On failure, responds with SdkError<AssociateProfilesError>

impl Client

pub fn create_lens_share(&self) -> CreateLensShareFluentBuilder

Constructs a fluent builder for the CreateLensShare operation.

• The fluent builder is configurable:
  • lens_alias(impl Into<String>) / set_lens_alias(Option<String>):
    required: true
    

    The alias of the lens.

    For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

    For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

    Each lens is identified by its LensSummary$LensAlias.

    
    
  • shared_with(impl Into<String>) / set_shared_with(Option<String>):
    required: true
    

    The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: true
    

    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.

    
    
• On success, responds with CreateLensShareOutput with field(s):
  • share_id(Option<String>):

    The ID associated with the share.

• On failure, responds with SdkError<CreateLensShareError>

impl Client

pub fn create_lens_version(&self) -> CreateLensVersionFluentBuilder

Constructs a fluent builder for the CreateLensVersion operation.

• The fluent builder is configurable:
  • lens_alias(impl Into<String>) / set_lens_alias(Option<String>):
    required: true
    

    The alias of the lens.

    For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

    For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

    Each lens is identified by its LensSummary$LensAlias.

    
    
  • lens_version(impl Into<String>) / set_lens_version(Option<String>):
    required: true
    

    The version of the lens being created.

    
    
  • is_major_version(bool) / set_is_major_version(Option<bool>):
    required: false
    

    Set to true if this new major lens version.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: true
    

    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.

    
    
• 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>

impl Client

pub fn create_milestone(&self) -> CreateMilestoneFluentBuilder

Constructs a fluent builder for the CreateMilestone operation.

• The fluent builder is configurable:
  • workload_id(impl Into<String>) / set_workload_id(Option<String>):
    required: true
    

    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>):
    required: true
    

    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>):
    required: true
    

    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.

    
    
• 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(Option<i32>):

    The milestone number.

    A workload can have a maximum of 100 milestones.

• On failure, responds with SdkError<CreateMilestoneError>

impl Client

pub fn create_profile(&self) -> CreateProfileFluentBuilder

Constructs a fluent builder for the CreateProfile operation.

• The fluent builder is configurable:
  • profile_name(impl Into<String>) / set_profile_name(Option<String>):
    required: true
    

    Name of the profile.

    
    
  • profile_description(impl Into<String>) / set_profile_description(Option<String>):
    required: true
    

    The profile description.

    
    
  • profile_questions(ProfileQuestionUpdate) / set_profile_questions(Option<Vec::<ProfileQuestionUpdate>>):
    required: true
    

    The profile questions.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: true
    

    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.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags assigned to the profile.

    
    
• On success, responds with CreateProfileOutput with field(s):
  • profile_arn(Option<String>):

    The profile ARN.

  • profile_version(Option<String>):

    Version of the profile.

• On failure, responds with SdkError<CreateProfileError>

impl Client

pub fn create_profile_share(&self) -> CreateProfileShareFluentBuilder

Constructs a fluent builder for the CreateProfileShare operation.

• The fluent builder is configurable:
  • profile_arn(impl Into<String>) / set_profile_arn(Option<String>):
    required: true
    

    The profile ARN.

    
    
  • shared_with(impl Into<String>) / set_shared_with(Option<String>):
    required: true
    

    The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: true
    

    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.

    
    
• On success, responds with CreateProfileShareOutput with field(s):
  • share_id(Option<String>):

    The ID associated with the share.

  • profile_arn(Option<String>):

    The profile ARN.

• On failure, responds with SdkError<CreateProfileShareError>

impl Client

pub fn create_review_template(&self) -> CreateReviewTemplateFluentBuilder

Constructs a fluent builder for the CreateReviewTemplate operation.

• The fluent builder is configurable:
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    Name of the review template.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: true
    

    The review template description.

    
    
  • lenses(impl Into<String>) / set_lenses(Option<Vec::<String>>):
    required: true
    

    Lenses applied to the review template.

    
    
  • notes(impl Into<String>) / set_notes(Option<String>):
    required: false
    

    The notes associated with the workload.

    For a review template, these are the notes that will be associated with the workload when the template is applied.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags assigned to the review template.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: true
    

    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.

    
    
• On success, responds with CreateReviewTemplateOutput with field(s):
  • template_arn(Option<String>):

    The review template ARN.

• On failure, responds with SdkError<CreateReviewTemplateError>

impl Client

pub fn create_template_share(&self) -> CreateTemplateShareFluentBuilder

Constructs a fluent builder for the CreateTemplateShare operation.

• The fluent builder is configurable:
  • template_arn(impl Into<String>) / set_template_arn(Option<String>):
    required: true
    

    The review template ARN.

    
    
  • shared_with(impl Into<String>) / set_shared_with(Option<String>):
    required: true
    

    The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: true
    

    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.

    
    
• On success, responds with CreateTemplateShareOutput with field(s):
  • template_arn(Option<String>):

    The review template ARN.

  • share_id(Option<String>):

    The ID associated with the share.

• On failure, responds with SdkError<CreateTemplateShareError>

impl Client

pub fn create_workload(&self) -> CreateWorkloadFluentBuilder

Constructs a fluent builder for the CreateWorkload operation.

• The fluent builder is configurable:
  • workload_name(impl Into<String>) / set_workload_name(Option<String>):
    required: true
    

    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>):
    required: true
    

    The description for the workload.

    
    
  • environment(WorkloadEnvironment) / set_environment(Option<WorkloadEnvironment>):
    required: true
    

    The environment for the workload.

    
    
  • account_ids(impl Into<String>) / set_account_ids(Option<Vec::<String>>):
    required: false
    

    The list of Amazon Web Services account IDs associated with the workload.

    
    
  • aws_regions(impl Into<String>) / set_aws_regions(Option<Vec::<String>>):
    required: false
    

    The list of Amazon Web Services Regions associated with the workload, for example, us-east-2, or ca-central-1.

    
    
  • non_aws_regions(impl Into<String>) / set_non_aws_regions(Option<Vec::<String>>):
    required: false
    

    The list of non-Amazon Web Services Regions associated with the workload.

    
    
  • pillar_priorities(impl Into<String>) / set_pillar_priorities(Option<Vec::<String>>):
    required: false
    

    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>):
    required: false
    

    The URL of the architectural design for the workload.

    
    
  • review_owner(impl Into<String>) / set_review_owner(Option<String>):
    required: false
    

    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>):
    required: false
    

    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>):
    required: false
    

    The industry for the workload.

    
    
  • lenses(impl Into<String>) / set_lenses(Option<Vec::<String>>):
    required: true
    

    The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias.

    If a review template that specifies lenses is applied to the workload, those lenses are applied to the workload in addition to these lenses.

    
    
  • notes(impl Into<String>) / set_notes(Option<String>):
    required: false
    

    The notes associated with the workload.

    For a review template, these are the notes that will be associated with the workload when the template is applied.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: true
    

    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.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags to be associated with the workload.

    
    
  • discovery_config(WorkloadDiscoveryConfig) / set_discovery_config(Option<WorkloadDiscoveryConfig>):
    required: false
    

    Well-Architected discovery configuration settings associated to the workload.

    
    
  • applications(impl Into<String>) / set_applications(Option<Vec::<String>>):
    required: false
    

    List of AppRegistry application ARNs associated to the workload.

    
    
  • profile_arns(impl Into<String>) / set_profile_arns(Option<Vec::<String>>):
    required: false
    

    The list of profile ARNs associated with the workload.

    
    
  • review_template_arns(impl Into<String>) / set_review_template_arns(Option<Vec::<String>>):
    required: false
    

    The list of review template ARNs to associate with the workload.

    
    
  • jira_configuration(WorkloadJiraConfigurationInput) / set_jira_configuration(Option<WorkloadJiraConfigurationInput>):
    required: false
    

    Jira configuration settings when creating a 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>

impl Client

pub fn create_workload_share(&self) -> CreateWorkloadShareFluentBuilder

Constructs a fluent builder for the CreateWorkloadShare operation.

• The fluent builder is configurable:
  • workload_id(impl Into<String>) / set_workload_id(Option<String>):
    required: true
    

    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>):
    required: true
    

    The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared.

    
    
  • permission_type(PermissionType) / set_permission_type(Option<PermissionType>):
    required: true
    

    Permission granted on a share request.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: true
    

    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.

    
    
• 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 share.

• On failure, responds with SdkError<CreateWorkloadShareError>

impl Client

pub fn delete_lens(&self) -> DeleteLensFluentBuilder

Constructs a fluent builder for the DeleteLens operation.

• The fluent builder is configurable:
  • lens_alias(impl Into<String>) / set_lens_alias(Option<String>):
    required: true
    

    The alias of the lens.

    For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

    For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

    Each lens is identified by its LensSummary$LensAlias.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: true
    

    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.

    
    
  • lens_status(LensStatusType) / set_lens_status(Option<LensStatusType>):
    required: true
    

    The status of the lens to be deleted.

    
    
• On success, responds with DeleteLensOutput
• On failure, responds with SdkError<DeleteLensError>

impl Client

pub fn delete_lens_share(&self) -> DeleteLensShareFluentBuilder

Constructs a fluent builder for the DeleteLensShare operation.

• The fluent builder is configurable:
  • share_id(impl Into<String>) / set_share_id(Option<String>):
    required: true
    

    The ID associated with the share.

    
    
  • lens_alias(impl Into<String>) / set_lens_alias(Option<String>):
    required: true
    

    The alias of the lens.

    For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

    For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

    Each lens is identified by its LensSummary$LensAlias.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: true
    

    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.

    
    
• On success, responds with DeleteLensShareOutput
• On failure, responds with SdkError<DeleteLensShareError>

impl Client

pub fn delete_profile(&self) -> DeleteProfileFluentBuilder

Constructs a fluent builder for the DeleteProfile operation.

• The fluent builder is configurable:
  • profile_arn(impl Into<String>) / set_profile_arn(Option<String>):
    required: true
    

    The profile ARN.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: true
    

    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.

    
    
• On success, responds with DeleteProfileOutput
• On failure, responds with SdkError<DeleteProfileError>

impl Client

pub fn delete_profile_share(&self) -> DeleteProfileShareFluentBuilder

Constructs a fluent builder for the DeleteProfileShare operation.

• The fluent builder is configurable:
  • share_id(impl Into<String>) / set_share_id(Option<String>):
    required: true
    

    The ID associated with the share.

    
    
  • profile_arn(impl Into<String>) / set_profile_arn(Option<String>):
    required: true
    

    The profile ARN.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: true
    

    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.

    
    
• On success, responds with DeleteProfileShareOutput
• On failure, responds with SdkError<DeleteProfileShareError>

impl Client

pub fn delete_review_template(&self) -> DeleteReviewTemplateFluentBuilder

Constructs a fluent builder for the DeleteReviewTemplate operation.

• The fluent builder is configurable:
  • template_arn(impl Into<String>) / set_template_arn(Option<String>):
    required: true
    

    The review template ARN.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: true
    

    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.

    
    
• On success, responds with DeleteReviewTemplateOutput
• On failure, responds with SdkError<DeleteReviewTemplateError>

impl Client

pub fn delete_template_share(&self) -> DeleteTemplateShareFluentBuilder

Constructs a fluent builder for the DeleteTemplateShare operation.

• The fluent builder is configurable:
  • share_id(impl Into<String>) / set_share_id(Option<String>):
    required: true
    

    The ID associated with the share.

    
    
  • template_arn(impl Into<String>) / set_template_arn(Option<String>):
    required: true
    

    The review template ARN.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: true
    

    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.

    
    
• On success, responds with DeleteTemplateShareOutput
• On failure, responds with SdkError<DeleteTemplateShareError>

impl Client

pub fn delete_workload(&self) -> DeleteWorkloadFluentBuilder

Constructs a fluent builder for the DeleteWorkload operation.

• The fluent builder is configurable:
  • workload_id(impl Into<String>) / set_workload_id(Option<String>):
    required: true
    

    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>):
    required: true
    

    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.

    
    
• On success, responds with DeleteWorkloadOutput
• On failure, responds with SdkError<DeleteWorkloadError>

impl Client

pub fn delete_workload_share(&self) -> DeleteWorkloadShareFluentBuilder

Constructs a fluent builder for the DeleteWorkloadShare operation.

• The fluent builder is configurable:
  • share_id(impl Into<String>) / set_share_id(Option<String>):
    required: true
    

    The ID associated with the share.

    
    
  • workload_id(impl Into<String>) / set_workload_id(Option<String>):
    required: true
    

    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>):
    required: true
    

    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.

    
    
• On success, responds with DeleteWorkloadShareOutput
• On failure, responds with SdkError<DeleteWorkloadShareError>

impl Client

pub fn disassociate_lenses(&self) -> DisassociateLensesFluentBuilder

Constructs a fluent builder for the DisassociateLenses operation.

• The fluent builder is configurable:
  • workload_id(impl Into<String>) / set_workload_id(Option<String>):
    required: true
    

    The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

    
    
  • lens_aliases(impl Into<String>) / set_lens_aliases(Option<Vec::<String>>):
    required: true
    

    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>

impl Client

pub fn disassociate_profiles(&self) -> DisassociateProfilesFluentBuilder

Constructs a fluent builder for the DisassociateProfiles operation.

• The fluent builder is configurable:
  • workload_id(impl Into<String>) / set_workload_id(Option<String>):
    required: true
    

    The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

    
    
  • profile_arns(impl Into<String>) / set_profile_arns(Option<Vec::<String>>):
    required: true
    

    The list of profile ARNs to disassociate from the workload.

    
    
• On success, responds with DisassociateProfilesOutput
• On failure, responds with SdkError<DisassociateProfilesError>

impl Client

pub fn export_lens(&self) -> ExportLensFluentBuilder

Constructs a fluent builder for the ExportLens operation.

• The fluent builder is configurable:
  • lens_alias(impl Into<String>) / set_lens_alias(Option<String>):
    required: true
    

    The alias of the lens.

    For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

    For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

    Each lens is identified by its LensSummary$LensAlias.

    
    
  • lens_version(impl Into<String>) / set_lens_version(Option<String>):
    required: false
    

    The lens version to be exported.

    
    
• On success, responds with ExportLensOutput with field(s):
  • lens_json(Option<String>):

    The JSON representation of a lens.

• On failure, responds with SdkError<ExportLensError>

impl Client

pub fn get_answer(&self) -> GetAnswerFluentBuilder

Constructs a fluent builder for the GetAnswer operation.

• The fluent builder is configurable:
  • workload_id(impl Into<String>) / set_workload_id(Option<String>):
    required: true
    

    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>):
    required: true
    

    The alias of the lens.

    For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

    For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

    Each lens is identified by its LensSummary$LensAlias.

    
    
  • question_id(impl Into<String>) / set_question_id(Option<String>):
    required: true
    

    The ID of the question.

    
    
  • milestone_number(i32) / set_milestone_number(Option<i32>):
    required: false
    

    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(Option<i32>):

    The milestone number.

    A workload can have a maximum of 100 milestones.

  • lens_alias(Option<String>):

    The alias of the lens.

    For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

    For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

    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>

impl Client

pub fn get_consolidated_report(&self) -> GetConsolidatedReportFluentBuilder

Constructs a fluent builder for the GetConsolidatedReport operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • format(ReportFormat) / set_format(Option<ReportFormat>):
    required: true
    

    The format of the consolidated report.

    For PDF, Base64String is returned. For JSON, Metrics is returned.

    
    
  • include_shared_resources(bool) / set_include_shared_resources(Option<bool>):
    required: false
    

    Set to true to have shared resources included in the report.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to use to retrieve the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return for this request.

    
    
• On success, responds with GetConsolidatedReportOutput with field(s):
  • metrics(Option<Vec::<ConsolidatedReportMetric>>):

    The metrics that make up the consolidated report.

    Only returned when JSON format is requested.

  • next_token(Option<String>):

    The token to use to retrieve the next set of results.

  • base64_string(Option<String>):

    The Base64-encoded string representation of a lens review report.

    This data can be used to create a PDF file.

    Only returned by GetConsolidatedReport when PDF format is requested.

• On failure, responds with SdkError<GetConsolidatedReportError>

impl Client

pub fn get_global_settings(&self) -> GetGlobalSettingsFluentBuilder

Constructs a fluent builder for the GetGlobalSettings operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetGlobalSettingsOutput with field(s):
  • organization_sharing_status(Option<OrganizationSharingStatus>):

    Amazon Web Services Organizations sharing status.

  • discovery_integration_status(Option<DiscoveryIntegrationStatus>):

    Discovery integration status.

  • jira_configuration(Option<AccountJiraConfigurationOutput>):

    Jira configuration status.

• On failure, responds with SdkError<GetGlobalSettingsError>

impl Client

pub fn get_lens(&self) -> GetLensFluentBuilder

Constructs a fluent builder for the GetLens operation.

• The fluent builder is configurable:
  • lens_alias(impl Into<String>) / set_lens_alias(Option<String>):
    required: true
    

    The alias of the lens.

    For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

    For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

    Each lens is identified by its LensSummary$LensAlias.

    
    
  • lens_version(impl Into<String>) / set_lens_version(Option<String>):
    required: false
    

    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>

impl Client

pub fn get_lens_review(&self) -> GetLensReviewFluentBuilder

Constructs a fluent builder for the GetLensReview operation.

• The fluent builder is configurable:
  • workload_id(impl Into<String>) / set_workload_id(Option<String>):
    required: true
    

    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>):
    required: true
    

    The alias of the lens.

    For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

    For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

    Each lens is identified by its LensSummary$LensAlias.

    
    
  • milestone_number(i32) / set_milestone_number(Option<i32>):
    required: false
    

    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(Option<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>

impl Client

pub fn get_lens_review_report(&self) -> GetLensReviewReportFluentBuilder

Constructs a fluent builder for the GetLensReviewReport operation.

• The fluent builder is configurable:
  • workload_id(impl Into<String>) / set_workload_id(Option<String>):
    required: true
    

    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>):
    required: true
    

    The alias of the lens.

    For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

    For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

    Each lens is identified by its LensSummary$LensAlias.

    
    
  • milestone_number(i32) / set_milestone_number(Option<i32>):
    required: false
    

    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(Option<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>

impl Client

pub fn get_lens_version_difference( &self, ) -> GetLensVersionDifferenceFluentBuilder

Constructs a fluent builder for the GetLensVersionDifference operation.

• The fluent builder is configurable:
  • lens_alias(impl Into<String>) / set_lens_alias(Option<String>):
    required: true
    

    The alias of the lens.

    For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

    For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

    Each lens is identified by its LensSummary$LensAlias.

    
    
  • base_lens_version(impl Into<String>) / set_base_lens_version(Option<String>):
    required: false
    

    The base version of the lens.

    
    
  • target_lens_version(impl Into<String>) / set_target_lens_version(Option<String>):
    required: false
    

    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 Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

    For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

    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>

impl Client

pub fn get_milestone(&self) -> GetMilestoneFluentBuilder

Constructs a fluent builder for the GetMilestone operation.

• The fluent builder is configurable:
  • workload_id(impl Into<String>) / set_workload_id(Option<String>):
    required: true
    

    The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

    
    
  • milestone_number(i32) / set_milestone_number(Option<i32>):
    required: true
    

    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>

impl Client

pub fn get_profile(&self) -> GetProfileFluentBuilder

Constructs a fluent builder for the GetProfile operation.

• The fluent builder is configurable:
  • profile_arn(impl Into<String>) / set_profile_arn(Option<String>):
    required: true
    

    The profile ARN.

    
    
  • profile_version(impl Into<String>) / set_profile_version(Option<String>):
    required: false
    

    The profile version.

    
    
• On success, responds with GetProfileOutput with field(s):
  • profile(Option<Profile>):

    The profile.

• On failure, responds with SdkError<GetProfileError>

impl Client

pub fn get_profile_template(&self) -> GetProfileTemplateFluentBuilder

Constructs a fluent builder for the GetProfileTemplate operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetProfileTemplateOutput with field(s):
  • profile_template(Option<ProfileTemplate>):

    The profile template.

• On failure, responds with SdkError<GetProfileTemplateError>

impl Client

pub fn get_review_template(&self) -> GetReviewTemplateFluentBuilder

Constructs a fluent builder for the GetReviewTemplate operation.

• The fluent builder is configurable:
  • template_arn(impl Into<String>) / set_template_arn(Option<String>):
    required: true
    

    The review template ARN.

    
    
• On success, responds with GetReviewTemplateOutput with field(s):
  • review_template(Option<ReviewTemplate>):

    The review template.

• On failure, responds with SdkError<GetReviewTemplateError>

impl Client

pub fn get_review_template_answer(&self) -> GetReviewTemplateAnswerFluentBuilder

Constructs a fluent builder for the GetReviewTemplateAnswer operation.

• The fluent builder is configurable:
  • template_arn(impl Into<String>) / set_template_arn(Option<String>):
    required: true
    

    The review template ARN.

    
    
  • lens_alias(impl Into<String>) / set_lens_alias(Option<String>):
    required: true
    

    The alias of the lens.

    For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

    For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

    Each lens is identified by its LensSummary$LensAlias.

    
    
  • question_id(impl Into<String>) / set_question_id(Option<String>):
    required: true
    

    The ID of the question.

    
    
• On success, responds with GetReviewTemplateAnswerOutput with field(s):
  • template_arn(Option<String>):

    The review template ARN.

  • lens_alias(Option<String>):

    The alias of the lens.

    For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

    For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

    Each lens is identified by its LensSummary$LensAlias.

  • answer(Option<ReviewTemplateAnswer>):

    An answer of the question.

• On failure, responds with SdkError<GetReviewTemplateAnswerError>

impl Client

pub fn get_review_template_lens_review( &self, ) -> GetReviewTemplateLensReviewFluentBuilder

Constructs a fluent builder for the GetReviewTemplateLensReview operation.

• The fluent builder is configurable:
  • template_arn(impl Into<String>) / set_template_arn(Option<String>):
    required: true
    

    The review template ARN.

    
    
  • lens_alias(impl Into<String>) / set_lens_alias(Option<String>):
    required: true
    

    The alias of the lens.

    For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

    For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

    Each lens is identified by its LensSummary$LensAlias.

    
    
• On success, responds with GetReviewTemplateLensReviewOutput with field(s):
  • template_arn(Option<String>):

    The review template ARN.

  • lens_review(Option<ReviewTemplateLensReview>):

    A lens review of a question.

• On failure, responds with SdkError<GetReviewTemplateLensReviewError>

impl Client

pub fn get_workload(&self) -> GetWorkloadFluentBuilder

Constructs a fluent builder for the GetWorkload operation.

• The fluent builder is configurable:
  • workload_id(impl Into<String>) / set_workload_id(Option<String>):
    required: true
    

    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>

impl Client

pub fn import_lens(&self) -> ImportLensFluentBuilder

Constructs a fluent builder for the ImportLens operation.

• The fluent builder is configurable:
  • lens_alias(impl Into<String>) / set_lens_alias(Option<String>):
    required: false
    

    The alias of the lens.

    For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

    For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

    Each lens is identified by its LensSummary$LensAlias.

    
    
  • json_string(impl Into<String>) / set_json_string(Option<String>):
    required: true
    

    The JSON representation of a lens.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: true
    

    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.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Tags to associate to a lens.

    
    
• On success, responds with ImportLensOutput with field(s):
  • lens_arn(Option<String>):

    The ARN for the lens that was created or updated.

  • status(Option<ImportLensStatus>):

    The status of the imported lens.

• On failure, responds with SdkError<ImportLensError>

impl Client

pub fn list_answers(&self) -> ListAnswersFluentBuilder

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>):
    required: true
    

    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>):
    required: true
    

    The alias of the lens.

    For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

    For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

    Each lens is identified by its LensSummary$LensAlias.

    
    
  • pillar_id(impl Into<String>) / set_pillar_id(Option<String>):
    required: false
    

    The ID used to identify a pillar, for example, security.

    A pillar is identified by its PillarReviewSummary$PillarId.

    
    
  • milestone_number(i32) / set_milestone_number(Option<i32>):
    required: false
    

    The milestone number.

    A workload can have a maximum of 100 milestones.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to use to retrieve the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return for this request.

    
    
  • question_priority(QuestionPriority) / set_question_priority(Option<QuestionPriority>):
    required: false
    

    The priority of the question.

    
    
• 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(Option<i32>):

    The milestone number.

    A workload can have a maximum of 100 milestones.

  • lens_alias(Option<String>):

    The alias of the lens.

    For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

    For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

    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>

impl Client

pub fn list_check_details(&self) -> ListCheckDetailsFluentBuilder

Constructs a fluent builder for the ListCheckDetails operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • workload_id(impl Into<String>) / set_workload_id(Option<String>):
    required: true
    

    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>):
    required: false
    

    The token to use to retrieve the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return for this request.

    
    
  • lens_arn(impl Into<String>) / set_lens_arn(Option<String>):
    required: true
    

    Well-Architected Lens ARN.

    
    
  • pillar_id(impl Into<String>) / set_pillar_id(Option<String>):
    required: true
    

    The ID used to identify a pillar, for example, security.

    A pillar is identified by its PillarReviewSummary$PillarId.

    
    
  • question_id(impl Into<String>) / set_question_id(Option<String>):
    required: true
    

    The ID of the question.

    
    
  • choice_id(impl Into<String>) / set_choice_id(Option<String>):
    required: true
    

    The ID of a choice.

    
    
• On success, responds with ListCheckDetailsOutput with field(s):
  • check_details(Option<Vec::<CheckDetail>>):

    The details about the Trusted Advisor checks related to the Well-Architected best practice.

  • next_token(Option<String>):

    The token to use to retrieve the next set of results.

• On failure, responds with SdkError<ListCheckDetailsError>

impl Client

pub fn list_check_summaries(&self) -> ListCheckSummariesFluentBuilder

Constructs a fluent builder for the ListCheckSummaries operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • workload_id(impl Into<String>) / set_workload_id(Option<String>):
    required: true
    

    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>):
    required: false
    

    The token to use to retrieve the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return for this request.

    
    
  • lens_arn(impl Into<String>) / set_lens_arn(Option<String>):
    required: true
    

    Well-Architected Lens ARN.

    
    
  • pillar_id(impl Into<String>) / set_pillar_id(Option<String>):
    required: true
    

    The ID used to identify a pillar, for example, security.

    A pillar is identified by its PillarReviewSummary$PillarId.

    
    
  • question_id(impl Into<String>) / set_question_id(Option<String>):
    required: true
    

    The ID of the question.

    
    
  • choice_id(impl Into<String>) / set_choice_id(Option<String>):
    required: true
    

    The ID of a choice.

    
    
• On success, responds with ListCheckSummariesOutput with field(s):
  • check_summaries(Option<Vec::<CheckSummary>>):

    List of Trusted Advisor summaries related to the Well-Architected best practice.

  • next_token(Option<String>):

    The token to use to retrieve the next set of results.

• On failure, responds with SdkError<ListCheckSummariesError>

impl Client

pub fn list_lens_review_improvements( &self, ) -> ListLensReviewImprovementsFluentBuilder

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>):
    required: true
    

    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>):
    required: true
    

    The alias of the lens.

    For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

    For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

    Each lens is identified by its LensSummary$LensAlias.

    
    
  • pillar_id(impl Into<String>) / set_pillar_id(Option<String>):
    required: false
    

    The ID used to identify a pillar, for example, security.

    A pillar is identified by its PillarReviewSummary$PillarId.

    
    
  • milestone_number(i32) / set_milestone_number(Option<i32>):
    required: false
    

    The milestone number.

    A workload can have a maximum of 100 milestones.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to use to retrieve the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return for this request.

    
    
  • question_priority(QuestionPriority) / set_question_priority(Option<QuestionPriority>):
    required: false
    

    The priority of the question.

    
    
• 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(Option<i32>):

    The milestone number.

    A workload can have a maximum of 100 milestones.

  • lens_alias(Option<String>):

    The alias of the lens.

    For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

    For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

    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>

impl Client

pub fn list_lens_reviews(&self) -> ListLensReviewsFluentBuilder

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>):
    required: true
    

    The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

    
    
  • milestone_number(i32) / set_milestone_number(Option<i32>):
    required: false
    

    The milestone number.

    A workload can have a maximum of 100 milestones.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to use to retrieve the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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(Option<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>

impl Client

pub fn list_lens_shares(&self) -> ListLensSharesFluentBuilder

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>):
    required: true
    

    The alias of the lens.

    For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

    For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

    Each lens is identified by its LensSummary$LensAlias.

    
    
  • shared_with_prefix(impl Into<String>) / set_shared_with_prefix(Option<String>):
    required: false
    

    The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the lens is shared.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to use to retrieve the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return for this request.

    
    
  • status(ShareStatus) / set_status(Option<ShareStatus>):
    required: false
    

    The status of the share 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>

impl Client

pub fn list_lenses(&self) -> ListLensesFluentBuilder

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>):
    required: false
    

    The token to use to retrieve the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return for this request.

    
    
  • lens_type(LensType) / set_lens_type(Option<LensType>):
    required: false
    

    The type of lenses to be returned.

    
    
  • lens_status(LensStatusType) / set_lens_status(Option<LensStatusType>):
    required: false
    

    The status of lenses to be returned.

    
    
  • lens_name(impl Into<String>) / set_lens_name(Option<String>):
    required: false
    

    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>

impl Client

pub fn list_milestones(&self) -> ListMilestonesFluentBuilder

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>):
    required: true
    

    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>):
    required: false
    

    The token to use to retrieve the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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>

impl Client

pub fn list_notifications(&self) -> ListNotificationsFluentBuilder

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>):
    required: false
    

    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>):
    required: false
    

    The token to use to retrieve the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return for this request.

    
    
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: false
    

    The ARN for the related resource for the notification.

    Only one of WorkloadID or ResourceARN should be specified.

    
    
• 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>

impl Client

pub fn list_profile_notifications( &self, ) -> ListProfileNotificationsFluentBuilder

Constructs a fluent builder for the ListProfileNotifications operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • workload_id(impl Into<String>) / set_workload_id(Option<String>):
    required: false
    

    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>):
    required: false
    

    The token to use to retrieve the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return for this request.

    
    
• On success, responds with ListProfileNotificationsOutput with field(s):
  • notification_summaries(Option<Vec::<ProfileNotificationSummary>>):

    Notification summaries.

  • next_token(Option<String>):

    The token to use to retrieve the next set of results.

• On failure, responds with SdkError<ListProfileNotificationsError>

impl Client

pub fn list_profile_shares(&self) -> ListProfileSharesFluentBuilder

Constructs a fluent builder for the ListProfileShares operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • profile_arn(impl Into<String>) / set_profile_arn(Option<String>):
    required: true
    

    The profile ARN.

    
    
  • shared_with_prefix(impl Into<String>) / set_shared_with_prefix(Option<String>):
    required: false
    

    The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the profile is shared.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to use to retrieve the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return for this request.

    
    
  • status(ShareStatus) / set_status(Option<ShareStatus>):
    required: false
    

    The status of the share request.

    
    
• On success, responds with ListProfileSharesOutput with field(s):
  • profile_share_summaries(Option<Vec::<ProfileShareSummary>>):

    Profile share summaries.

  • next_token(Option<String>):

    The token to use to retrieve the next set of results.

• On failure, responds with SdkError<ListProfileSharesError>

impl Client

pub fn list_profiles(&self) -> ListProfilesFluentBuilder

Constructs a fluent builder for the ListProfiles operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • profile_name_prefix(impl Into<String>) / set_profile_name_prefix(Option<String>):
    required: false
    

    An optional string added to the beginning of each profile name returned in the results.

    
    
  • profile_owner_type(ProfileOwnerType) / set_profile_owner_type(Option<ProfileOwnerType>):
    required: false
    

    Profile owner type.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to use to retrieve the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return for this request.

    
    
• On success, responds with ListProfilesOutput with field(s):
  • profile_summaries(Option<Vec::<ProfileSummary>>):

    Profile summaries.

  • next_token(Option<String>):

    The token to use to retrieve the next set of results.

• On failure, responds with SdkError<ListProfilesError>

impl Client

pub fn list_review_template_answers( &self, ) -> ListReviewTemplateAnswersFluentBuilder

Constructs a fluent builder for the ListReviewTemplateAnswers operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • template_arn(impl Into<String>) / set_template_arn(Option<String>):
    required: true
    

    The ARN of the review template.

    
    
  • lens_alias(impl Into<String>) / set_lens_alias(Option<String>):
    required: true
    

    The alias of the lens.

    For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

    For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

    Each lens is identified by its LensSummary$LensAlias.

    
    
  • pillar_id(impl Into<String>) / set_pillar_id(Option<String>):
    required: false
    

    The ID used to identify a pillar, for example, security.

    A pillar is identified by its PillarReviewSummary$PillarId.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to use to retrieve the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return for this request.

    
    
• On success, responds with ListReviewTemplateAnswersOutput with field(s):
  • template_arn(Option<String>):

    The ARN of the review template.

  • lens_alias(Option<String>):

    The alias of the lens.

    For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

    For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

    Each lens is identified by its LensSummary$LensAlias.

  • answer_summaries(Option<Vec::<ReviewTemplateAnswerSummary>>):

    List of answer summaries of a lens review in a review template.

  • next_token(Option<String>):

    The token to use to retrieve the next set of results.

• On failure, responds with SdkError<ListReviewTemplateAnswersError>

impl Client

pub fn list_review_templates(&self) -> ListReviewTemplatesFluentBuilder

Constructs a fluent builder for the ListReviewTemplates operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to use to retrieve the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return for this request.

    
    
• On success, responds with ListReviewTemplatesOutput with field(s):
  • review_templates(Option<Vec::<ReviewTemplateSummary>>):

    List of review templates.

  • next_token(Option<String>):

    The token to use to retrieve the next set of results.

• On failure, responds with SdkError<ListReviewTemplatesError>

impl Client

pub fn list_share_invitations(&self) -> ListShareInvitationsFluentBuilder

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>):
    required: false
    

    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>):
    required: false
    

    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>):
    required: false
    

    The type of share invitations to be returned.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to use to retrieve the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return for this request.

    
    
  • profile_name_prefix(impl Into<String>) / set_profile_name_prefix(Option<String>):
    required: false
    

    An optional string added to the beginning of each profile name returned in the results.

    
    
  • template_name_prefix(impl Into<String>) / set_template_name_prefix(Option<String>):
    required: false
    

    An optional string added to the beginning of each review template name returned in the results.

    
    
• 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>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • workload_arn(impl Into<String>) / set_workload_arn(Option<String>):
    required: true
    

    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>

impl Client

pub fn list_template_shares(&self) -> ListTemplateSharesFluentBuilder

Constructs a fluent builder for the ListTemplateShares operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • template_arn(impl Into<String>) / set_template_arn(Option<String>):
    required: true
    

    The review template ARN.

    
    
  • shared_with_prefix(impl Into<String>) / set_shared_with_prefix(Option<String>):
    required: false
    

    The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the profile is shared.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to use to retrieve the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return for this request.

    
    
  • status(ShareStatus) / set_status(Option<ShareStatus>):
    required: false
    

    The status of the share request.

    
    
• On success, responds with ListTemplateSharesOutput with field(s):
  • template_arn(Option<String>):

    The review template ARN.

  • template_share_summaries(Option<Vec::<TemplateShareSummary>>):

    A review template share summary return object.

  • next_token(Option<String>):

    The token to use to retrieve the next set of results.

• On failure, responds with SdkError<ListTemplateSharesError>

impl Client

pub fn list_workload_shares(&self) -> ListWorkloadSharesFluentBuilder

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>):
    required: true
    

    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>):
    required: false
    

    The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload is shared.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to use to retrieve the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return for this request.

    
    
  • status(ShareStatus) / set_status(Option<ShareStatus>):
    required: false
    

    The status of the share 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>

impl Client

pub fn list_workloads(&self) -> ListWorkloadsFluentBuilder

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>):
    required: false
    

    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>):
    required: false
    

    The token to use to retrieve the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • workload_arn(impl Into<String>) / set_workload_arn(Option<String>):
    required: true
    

    The ARN for the workload.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    The tags for the resource.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • workload_arn(impl Into<String>) / set_workload_arn(Option<String>):
    required: true
    

    The ARN for the workload.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    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>

impl Client

pub fn update_answer(&self) -> UpdateAnswerFluentBuilder

Constructs a fluent builder for the UpdateAnswer operation.

• The fluent builder is configurable:
  • workload_id(impl Into<String>) / set_workload_id(Option<String>):
    required: true
    

    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>):
    required: true
    

    The alias of the lens.

    For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

    For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

    Each lens is identified by its LensSummary$LensAlias.

    
    
  • question_id(impl Into<String>) / set_question_id(Option<String>):
    required: true
    

    The ID of the question.

    
    
  • selected_choices(impl Into<String>) / set_selected_choices(Option<Vec::<String>>):
    required: false
    

    List of selected choice IDs in a question answer.

    The values entered replace the previously selected choices.

    
    
  • choice_updates(impl Into<String>, ChoiceUpdate) / set_choice_updates(Option<HashMap::<String, ChoiceUpdate>>):
    required: false
    

    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>):
    required: false
    

    The notes associated with the workload.

    For a review template, these are the notes that will be associated with the workload when the template is applied.

    
    
  • is_applicable(bool) / set_is_applicable(Option<bool>):
    required: false
    

    Defines whether this question is applicable to a lens review.

    
    
  • reason(AnswerReason) / set_reason(Option<AnswerReason>):
    required: false
    

    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 Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

    For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

    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>

impl Client

pub fn update_global_settings(&self) -> UpdateGlobalSettingsFluentBuilder

Constructs a fluent builder for the UpdateGlobalSettings operation.

• The fluent builder is configurable:
  • organization_sharing_status(OrganizationSharingStatus) / set_organization_sharing_status(Option<OrganizationSharingStatus>):
    required: false
    

    The status of organization sharing settings.

    
    
  • discovery_integration_status(DiscoveryIntegrationStatus) / set_discovery_integration_status(Option<DiscoveryIntegrationStatus>):
    required: false
    

    The status of discovery support settings.

    
    
  • jira_configuration(AccountJiraConfigurationInput) / set_jira_configuration(Option<AccountJiraConfigurationInput>):
    required: false
    

    The status of Jira integration settings.

    
    
• On success, responds with UpdateGlobalSettingsOutput
• On failure, responds with SdkError<UpdateGlobalSettingsError>

impl Client

pub fn update_integration(&self) -> UpdateIntegrationFluentBuilder

Constructs a fluent builder for the UpdateIntegration operation.

• The fluent builder is configurable:
  • workload_id(impl Into<String>) / set_workload_id(Option<String>):
    required: true
    

    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>):
    required: true
    

    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.

    
    
  • integrating_service(IntegratingService) / set_integrating_service(Option<IntegratingService>):
    required: true
    

    Which integrated service to update.

    
    
• On success, responds with UpdateIntegrationOutput
• On failure, responds with SdkError<UpdateIntegrationError>

impl Client

pub fn update_lens_review(&self) -> UpdateLensReviewFluentBuilder

Constructs a fluent builder for the UpdateLensReview operation.

• The fluent builder is configurable:
  • workload_id(impl Into<String>) / set_workload_id(Option<String>):
    required: true
    

    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>):
    required: true
    

    The alias of the lens.

    For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

    For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

    Each lens is identified by its LensSummary$LensAlias.

    
    
  • lens_notes(impl Into<String>) / set_lens_notes(Option<String>):
    required: false
    

    The notes associated with the workload.

    For a review template, these are the notes that will be associated with the workload when the template is applied.

    
    
  • pillar_notes(impl Into<String>, impl Into<String>) / set_pillar_notes(Option<HashMap::<String, String>>):
    required: false
    

    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.

    
    
  • jira_configuration(JiraSelectedQuestionConfiguration) / set_jira_configuration(Option<JiraSelectedQuestionConfiguration>):
    required: false
    

    Configuration of the Jira integration.

    
    
• 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>

impl Client

pub fn update_profile(&self) -> UpdateProfileFluentBuilder

Constructs a fluent builder for the UpdateProfile operation.

• The fluent builder is configurable:
  • profile_arn(impl Into<String>) / set_profile_arn(Option<String>):
    required: true
    

    The profile ARN.

    
    
  • profile_description(impl Into<String>) / set_profile_description(Option<String>):
    required: false
    

    The profile description.

    
    
  • profile_questions(ProfileQuestionUpdate) / set_profile_questions(Option<Vec::<ProfileQuestionUpdate>>):
    required: false
    

    Profile questions.

    
    
• On success, responds with UpdateProfileOutput with field(s):
  • profile(Option<Profile>):

    The profile.

• On failure, responds with SdkError<UpdateProfileError>

impl Client

pub fn update_review_template(&self) -> UpdateReviewTemplateFluentBuilder

Constructs a fluent builder for the UpdateReviewTemplate operation.

• The fluent builder is configurable:
  • template_arn(impl Into<String>) / set_template_arn(Option<String>):
    required: true
    

    The review template ARN.

    
    
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: false
    

    The review template name.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The review template description.

    
    
  • notes(impl Into<String>) / set_notes(Option<String>):
    required: false
    

    The notes associated with the workload.

    For a review template, these are the notes that will be associated with the workload when the template is applied.

    
    
  • lenses_to_associate(impl Into<String>) / set_lenses_to_associate(Option<Vec::<String>>):
    required: false
    

    A list of lens aliases or ARNs to apply to the review template.

    
    
  • lenses_to_disassociate(impl Into<String>) / set_lenses_to_disassociate(Option<Vec::<String>>):
    required: false
    

    A list of lens aliases or ARNs to unapply to the review template. The wellarchitected lens cannot be unapplied.

    
    
• On success, responds with UpdateReviewTemplateOutput with field(s):
  • review_template(Option<ReviewTemplate>):

    A review template.

• On failure, responds with SdkError<UpdateReviewTemplateError>

impl Client

pub fn update_review_template_answer( &self, ) -> UpdateReviewTemplateAnswerFluentBuilder

Constructs a fluent builder for the UpdateReviewTemplateAnswer operation.

• The fluent builder is configurable:
  • template_arn(impl Into<String>) / set_template_arn(Option<String>):
    required: true
    

    The review template ARN.

    
    
  • lens_alias(impl Into<String>) / set_lens_alias(Option<String>):
    required: true
    

    The alias of the lens.

    For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

    For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

    Each lens is identified by its LensSummary$LensAlias.

    
    
  • question_id(impl Into<String>) / set_question_id(Option<String>):
    required: true
    

    The ID of the question.

    
    
  • selected_choices(impl Into<String>) / set_selected_choices(Option<Vec::<String>>):
    required: false
    

    List of selected choice IDs in a question answer.

    The values entered replace the previously selected choices.

    
    
  • choice_updates(impl Into<String>, ChoiceUpdate) / set_choice_updates(Option<HashMap::<String, ChoiceUpdate>>):
    required: false
    

    A list of choices to be updated.

    
    
  • notes(impl Into<String>) / set_notes(Option<String>):
    required: false
    

    The notes associated with the workload.

    For a review template, these are the notes that will be associated with the workload when the template is applied.

    
    
  • is_applicable(bool) / set_is_applicable(Option<bool>):
    required: false
    

    Defines whether this question is applicable to a lens review.

    
    
  • reason(AnswerReason) / set_reason(Option<AnswerReason>):
    required: false
    

    The update reason.

    
    
• On success, responds with UpdateReviewTemplateAnswerOutput with field(s):
  • template_arn(Option<String>):

    The review template ARN.

  • lens_alias(Option<String>):

    The alias of the lens.

    For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

    For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

    Each lens is identified by its LensSummary$LensAlias.

  • answer(Option<ReviewTemplateAnswer>):

    An answer of the question.

• On failure, responds with SdkError<UpdateReviewTemplateAnswerError>

impl Client

pub fn update_review_template_lens_review( &self, ) -> UpdateReviewTemplateLensReviewFluentBuilder

Constructs a fluent builder for the UpdateReviewTemplateLensReview operation.

• The fluent builder is configurable:
  • template_arn(impl Into<String>) / set_template_arn(Option<String>):
    required: true
    

    The review template ARN.

    
    
  • lens_alias(impl Into<String>) / set_lens_alias(Option<String>):
    required: true
    

    The alias of the lens.

    For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

    For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

    Each lens is identified by its LensSummary$LensAlias.

    
    
  • lens_notes(impl Into<String>) / set_lens_notes(Option<String>):
    required: false
    

    The notes associated with the workload.

    For a review template, these are the notes that will be associated with the workload when the template is applied.

    
    
  • pillar_notes(impl Into<String>, impl Into<String>) / set_pillar_notes(Option<HashMap::<String, String>>):
    required: false
    

    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.

    
    
• On success, responds with UpdateReviewTemplateLensReviewOutput with field(s):
  • template_arn(Option<String>):

    The review template ARN.

  • lens_review(Option<ReviewTemplateLensReview>):

    A lens review of a question.

• On failure, responds with SdkError<UpdateReviewTemplateLensReviewError>

impl Client

pub fn update_share_invitation(&self) -> UpdateShareInvitationFluentBuilder

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>):
    required: true
    

    The ID assigned to the share invitation.

    
    
  • share_invitation_action(ShareInvitationAction) / set_share_invitation_action(Option<ShareInvitationAction>):
    required: true
    

    Share invitation action taken by contributor.

    
    
• On success, responds with UpdateShareInvitationOutput with field(s):
  • share_invitation(Option<ShareInvitation>):

    The updated workload or custom lens share invitation.

• On failure, responds with SdkError<UpdateShareInvitationError>

impl Client

pub fn update_workload(&self) -> UpdateWorkloadFluentBuilder

Constructs a fluent builder for the UpdateWorkload operation.

• The fluent builder is configurable:
  • workload_id(impl Into<String>) / set_workload_id(Option<String>):
    required: true
    

    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>):
    required: false
    

    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>):
    required: false
    

    The description for the workload.

    
    
  • environment(WorkloadEnvironment) / set_environment(Option<WorkloadEnvironment>):
    required: false
    

    The environment for the workload.

    
    
  • account_ids(impl Into<String>) / set_account_ids(Option<Vec::<String>>):
    required: false
    

    The list of Amazon Web Services account IDs associated with the workload.

    
    
  • aws_regions(impl Into<String>) / set_aws_regions(Option<Vec::<String>>):
    required: false
    

    The list of Amazon Web Services Regions associated with the workload, for example, us-east-2, or ca-central-1.

    
    
  • non_aws_regions(impl Into<String>) / set_non_aws_regions(Option<Vec::<String>>):
    required: false
    

    The list of non-Amazon Web Services Regions associated with the workload.

    
    
  • pillar_priorities(impl Into<String>) / set_pillar_priorities(Option<Vec::<String>>):
    required: false
    

    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>):
    required: false
    

    The URL of the architectural design for the workload.

    
    
  • review_owner(impl Into<String>) / set_review_owner(Option<String>):
    required: false
    

    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(Option<bool>):
    required: false
    

    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>):
    required: false
    

    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>):
    required: false
    

    The industry for the workload.

    
    
  • notes(impl Into<String>) / set_notes(Option<String>):
    required: false
    

    The notes associated with the workload.

    For a review template, these are the notes that will be associated with the workload when the template is applied.

    
    
  • improvement_status(WorkloadImprovementStatus) / set_improvement_status(Option<WorkloadImprovementStatus>):
    required: false
    

    The improvement status for a workload.

    
    
  • discovery_config(WorkloadDiscoveryConfig) / set_discovery_config(Option<WorkloadDiscoveryConfig>):
    required: false
    

    Well-Architected discovery configuration settings to associate to the workload.

    
    
  • applications(impl Into<String>) / set_applications(Option<Vec::<String>>):
    required: false
    

    List of AppRegistry application ARNs to associate to the workload.

    
    
  • jira_configuration(WorkloadJiraConfigurationInput) / set_jira_configuration(Option<WorkloadJiraConfigurationInput>):
    required: false
    

    Configuration of the Jira integration.

    
    
• On success, responds with UpdateWorkloadOutput with field(s):
  • workload(Option<Workload>):

    A workload return object.

• On failure, responds with SdkError<UpdateWorkloadError>

impl Client

pub fn update_workload_share(&self) -> UpdateWorkloadShareFluentBuilder

Constructs a fluent builder for the UpdateWorkloadShare operation.

• The fluent builder is configurable:
  • share_id(impl Into<String>) / set_share_id(Option<String>):
    required: true
    

    The ID associated with the share.

    
    
  • workload_id(impl Into<String>) / set_workload_id(Option<String>):
    required: true
    

    The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

    
    
  • permission_type(PermissionType) / set_permission_type(Option<PermissionType>):
    required: true
    

    Permission granted on a share request.

    
    
• 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>

impl Client

pub fn upgrade_lens_review(&self) -> UpgradeLensReviewFluentBuilder

Constructs a fluent builder for the UpgradeLensReview operation.

• The fluent builder is configurable:
  • workload_id(impl Into<String>) / set_workload_id(Option<String>):
    required: true
    

    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>):
    required: true
    

    The alias of the lens.

    For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

    For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

    Each lens is identified by its LensSummary$LensAlias.

    
    
  • milestone_name(impl Into<String>) / set_milestone_name(Option<String>):
    required: true
    

    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>):
    required: false
    

    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.

    
    
• On success, responds with UpgradeLensReviewOutput
• On failure, responds with SdkError<UpgradeLensReviewError>

impl Client

pub fn upgrade_profile_version(&self) -> UpgradeProfileVersionFluentBuilder

Constructs a fluent builder for the UpgradeProfileVersion operation.

• The fluent builder is configurable:
  • workload_id(impl Into<String>) / set_workload_id(Option<String>):
    required: true
    

    The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

    
    
  • profile_arn(impl Into<String>) / set_profile_arn(Option<String>):
    required: true
    

    The profile ARN.

    
    
  • milestone_name(impl Into<String>) / set_milestone_name(Option<String>):
    required: false
    

    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>):
    required: false
    

    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.

    
    
• On success, responds with UpgradeProfileVersionOutput
• On failure, responds with SdkError<UpgradeProfileVersionError>

impl Client

pub fn upgrade_review_template_lens_review( &self, ) -> UpgradeReviewTemplateLensReviewFluentBuilder

Constructs a fluent builder for the UpgradeReviewTemplateLensReview operation.

• The fluent builder is configurable:
  • template_arn(impl Into<String>) / set_template_arn(Option<String>):
    required: true
    

    The ARN of the review template.

    
    
  • lens_alias(impl Into<String>) / set_lens_alias(Option<String>):
    required: true
    

    The alias of the lens.

    For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

    For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

    Each lens is identified by its LensSummary$LensAlias.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with UpgradeReviewTemplateLensReviewOutput
• On failure, responds with SdkError<UpgradeReviewTemplateLensReviewError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.