Struct ClientCopy item path

Constructs a fluent builder for the ApplyArchiveRule operation.

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

    The Amazon resource name (ARN) of the analyzer.

    
    
  • rule_name(impl Into<String>) / set_rule_name(Option<String>):
    required: true
    

    The name of the rule to apply.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A client token.

    
    
• On success, responds with ApplyArchiveRuleOutput
• On failure, responds with SdkError<ApplyArchiveRuleError>

Constructs a fluent builder for the CancelPolicyGeneration operation.

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

    The JobId that is returned by the StartPolicyGeneration operation. The JobId can be used with GetGeneratedPolicy to retrieve the generated policies or used with CancelPolicyGeneration to cancel the policy generation request.

    
    
• On success, responds with CancelPolicyGenerationOutput
• On failure, responds with SdkError<CancelPolicyGenerationError>

Constructs a fluent builder for the CheckAccessNotGranted operation.

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

    The JSON policy document to use as the content for the policy.

    
    
  • access(Access) / set_access(Option<Vec::<Access>>):
    required: true
    

    An access object containing the permissions that shouldn’t be granted by the specified policy. If only actions are specified, IAM Access Analyzer checks for access to peform at least one of the actions on any resource in the policy. If only resources are specified, then IAM Access Analyzer checks for access to perform any action on at least one of the resources. If both actions and resources are specified, IAM Access Analyzer checks for access to perform at least one of the specified actions on at least one of the specified resources.

    
    
  • policy_type(AccessCheckPolicyType) / set_policy_type(Option<AccessCheckPolicyType>):
    required: true
    

    The type of policy. Identity policies grant permissions to IAM principals. Identity policies include managed and inline policies for IAM roles, users, and groups.

    Resource policies grant permissions on Amazon Web Services resources. Resource policies include trust policies for IAM roles and bucket policies for Amazon S3 buckets.

    
    
• On success, responds with CheckAccessNotGrantedOutput with field(s):
  • result(Option<CheckAccessNotGrantedResult>):

    The result of the check for whether the access is allowed. If the result is PASS, the specified policy doesn’t allow any of the specified permissions in the access object. If the result is FAIL, the specified policy might allow some or all of the permissions in the access object.

  • message(Option<String>):

    The message indicating whether the specified access is allowed.

  • reasons(Option<Vec::<ReasonSummary>>):

    A description of the reasoning of the result.

• On failure, responds with SdkError<CheckAccessNotGrantedError>

Constructs a fluent builder for the CheckNoNewAccess operation.

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

    The JSON policy document to use as the content for the updated policy.

    
    
  • existing_policy_document(impl Into<String>) / set_existing_policy_document(Option<String>):
    required: true
    

    The JSON policy document to use as the content for the existing policy.

    
    
  • policy_type(AccessCheckPolicyType) / set_policy_type(Option<AccessCheckPolicyType>):
    required: true
    

    The type of policy to compare. Identity policies grant permissions to IAM principals. Identity policies include managed and inline policies for IAM roles, users, and groups.

    Resource policies grant permissions on Amazon Web Services resources. Resource policies include trust policies for IAM roles and bucket policies for Amazon S3 buckets. You can provide a generic input such as identity policy or resource policy or a specific input such as managed policy or Amazon S3 bucket policy.

    
    
• On success, responds with CheckNoNewAccessOutput with field(s):
  • result(Option<CheckNoNewAccessResult>):

    The result of the check for new access. If the result is PASS, no new access is allowed by the updated policy. If the result is FAIL, the updated policy might allow new access.

  • message(Option<String>):

    The message indicating whether the updated policy allows new access.

  • reasons(Option<Vec::<ReasonSummary>>):

    A description of the reasoning of the result.

• On failure, responds with SdkError<CheckNoNewAccessError>

Constructs a fluent builder for the CheckNoPublicAccess operation.

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

    The JSON policy document to evaluate for public access.

    
    
  • resource_type(AccessCheckResourceType) / set_resource_type(Option<AccessCheckResourceType>):
    required: true
    

    The type of resource to evaluate for public access. For example, to check for public access to Amazon S3 buckets, you can choose AWS::S3::Bucket for the resource type.

    For resource types not supported as valid values, IAM Access Analyzer will return an error.

    
    
• On success, responds with CheckNoPublicAccessOutput with field(s):
  • result(Option<CheckNoPublicAccessResult>):

    The result of the check for public access to the specified resource type. If the result is PASS, the policy doesn’t allow public access to the specified resource type. If the result is FAIL, the policy might allow public access to the specified resource type.

  • message(Option<String>):

    The message indicating whether the specified policy allows public access to resources.

  • reasons(Option<Vec::<ReasonSummary>>):

    A list of reasons why the specified resource policy grants public access for the resource type.

• On failure, responds with SdkError<CheckNoPublicAccessError>

Constructs a fluent builder for the CreateAccessPreview operation.

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

    The ARN of the account analyzer used to generate the access preview. You can only create an access preview for analyzers with an Account type and Active status.

    
    
  • configurations(impl Into<String>, Configuration) / set_configurations(Option<HashMap::<String, Configuration>>):
    required: true
    

    Access control configuration for your resource that is used to generate the access preview. The access preview includes findings for external access allowed to the resource with the proposed access control configuration. The configuration must contain exactly one element.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A client token.

    
    
• On success, responds with CreateAccessPreviewOutput with field(s):
  • id(String):

    The unique ID for the access preview.

• On failure, responds with SdkError<CreateAccessPreviewError>

Constructs a fluent builder for the CreateAnalyzer operation.

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

    The name of the analyzer to create.

    
    
  • r#type(Type) / set_type(Option<Type>):
    required: true
    

    The type of analyzer to create. Only ACCOUNT, ORGANIZATION, ACCOUNT_UNUSED_ACCESS, and ORGANIZATION_UNUSED_ACCESS analyzers are supported. You can create only one analyzer per account per Region. You can create up to 5 analyzers per organization per Region.

    
    
  • archive_rules(InlineArchiveRule) / set_archive_rules(Option<Vec::<InlineArchiveRule>>):
    required: false
    

    Specifies the archive rules to add for the analyzer. Archive rules automatically archive findings that meet the criteria you define for the rule.

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

    An array of key-value pairs to apply to the analyzer. You can use the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

    For the tag key, you can specify a value that is 1 to 128 characters in length and cannot be prefixed with aws:.

    For the tag value, you can specify a value that is 0 to 256 characters in length.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A client token.

    
    
  • configuration(AnalyzerConfiguration) / set_configuration(Option<AnalyzerConfiguration>):
    required: false
    

    Specifies the configuration of the analyzer. If the analyzer is an unused access analyzer, the specified scope of unused access is used for the configuration.

    
    
• On success, responds with CreateAnalyzerOutput with field(s):
  • arn(Option<String>):

    The ARN of the analyzer that was created by the request.

• On failure, responds with SdkError<CreateAnalyzerError>

Constructs a fluent builder for the CreateArchiveRule operation.

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

    The name of the created analyzer.

    
    
  • rule_name(impl Into<String>) / set_rule_name(Option<String>):
    required: true
    

    The name of the rule to create.

    
    
  • filter(impl Into<String>, Criterion) / set_filter(Option<HashMap::<String, Criterion>>):
    required: true
    

    The criteria for the rule.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A client token.

    
    
• On success, responds with CreateArchiveRuleOutput
• On failure, responds with SdkError<CreateArchiveRuleError>

Constructs a fluent builder for the DeleteAnalyzer operation.

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

    The name of the analyzer to delete.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A client token.

    
    
• On success, responds with DeleteAnalyzerOutput
• On failure, responds with SdkError<DeleteAnalyzerError>

Constructs a fluent builder for the DeleteArchiveRule operation.

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

    The name of the analyzer that associated with the archive rule to delete.

    
    
  • rule_name(impl Into<String>) / set_rule_name(Option<String>):
    required: true
    

    The name of the rule to delete.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A client token.

    
    
• On success, responds with DeleteArchiveRuleOutput
• On failure, responds with SdkError<DeleteArchiveRuleError>

Constructs a fluent builder for the GenerateFindingRecommendation operation.

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

    The ARN of the analyzer used to generate the finding recommendation.

    
    
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The unique ID for the finding recommendation.

    
    
• On success, responds with GenerateFindingRecommendationOutput
• On failure, responds with SdkError<GenerateFindingRecommendationError>

Constructs a fluent builder for the GetAccessPreview operation.

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

    The unique ID for the access preview.

    
    
  • analyzer_arn(impl Into<String>) / set_analyzer_arn(Option<String>):
    required: true
    

    The ARN of the analyzer used to generate the access preview.

    
    
• On success, responds with GetAccessPreviewOutput with field(s):
  • access_preview(Option<AccessPreview>):

    An object that contains information about the access preview.

• On failure, responds with SdkError<GetAccessPreviewError>

Constructs a fluent builder for the GetAnalyzedResource operation.

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

    The ARN of the analyzer to retrieve information from.

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

    The ARN of the resource to retrieve information about.

    
    
• On success, responds with GetAnalyzedResourceOutput with field(s):
  • resource(Option<AnalyzedResource>):

    An AnalyzedResource object that contains information that IAM Access Analyzer found when it analyzed the resource.

• On failure, responds with SdkError<GetAnalyzedResourceError>

Constructs a fluent builder for the GetAnalyzer operation.

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

    The name of the analyzer retrieved.

    
    
• On success, responds with GetAnalyzerOutput with field(s):
  • analyzer(Option<AnalyzerSummary>):

    An AnalyzerSummary object that contains information about the analyzer.

• On failure, responds with SdkError<GetAnalyzerError>

Constructs a fluent builder for the GetArchiveRule operation.

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

    The name of the analyzer to retrieve rules from.

    
    
  • rule_name(impl Into<String>) / set_rule_name(Option<String>):
    required: true
    

    The name of the rule to retrieve.

    
    
• On success, responds with GetArchiveRuleOutput with field(s):
  • archive_rule(Option<ArchiveRuleSummary>):

    Contains information about an archive rule. Archive rules automatically archive new findings that meet the criteria you define when you create the rule.

• On failure, responds with SdkError<GetArchiveRuleError>

Constructs a fluent builder for the GetFinding operation.

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

    The ARN of the analyzer that generated the finding.

    
    
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of the finding to retrieve.

    
    
• On success, responds with GetFindingOutput with field(s):
  • finding(Option<Finding>):

    A finding object that contains finding details.

• On failure, responds with SdkError<GetFindingError>

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

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

    The ARN of the analyzer used to generate the finding recommendation.

    
    
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The unique ID for the finding recommendation.

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

    The maximum number of results to return in the response.

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

    A token used for pagination of results returned.

    
    
• On success, responds with GetFindingRecommendationOutput with field(s):
  • started_at(DateTime):

    The time at which the retrieval of the finding recommendation was started.

  • completed_at(Option<DateTime>):

    The time at which the retrieval of the finding recommendation was completed.

  • next_token(Option<String>):

    A token used for pagination of results returned.

  • error(Option<RecommendationError>):

    Detailed information about the reason that the retrieval of a recommendation for the finding failed.

  • resource_arn(String):

    The ARN of the resource of the finding.

  • recommended_steps(Option<Vec::<RecommendedStep>>):

    A group of recommended steps for the finding.

  • recommendation_type(RecommendationType):

    The type of recommendation for the finding.

  • status(Status):

    The status of the retrieval of the finding recommendation.

• On failure, responds with SdkError<GetFindingRecommendationError>

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

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

    The ARN of the analyzer that generated the finding.

    
    
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of the finding to retrieve.

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

    The maximum number of results to return in the response.

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

    A token used for pagination of results returned.

    
    
• On success, responds with GetFindingV2Output with field(s):
  • analyzed_at(DateTime):

    The time at which the resource-based policy or IAM entity that generated the finding was analyzed.

  • created_at(DateTime):

    The time at which the finding was created.

  • error(Option<String>):

    An error.

  • id(String):

    The ID of the finding to retrieve.

  • next_token(Option<String>):

    A token used for pagination of results returned.

  • resource(Option<String>):

    The resource that generated the finding.

  • resource_type(ResourceType):

    The type of the resource identified in the finding.

  • resource_owner_account(String):

    Tye Amazon Web Services account ID that owns the resource.

  • status(FindingStatus):

    The status of the finding.

  • updated_at(DateTime):

    The time at which the finding was updated.

  • finding_details(Vec::<FindingDetails>):

    A localized message that explains the finding and provides guidance on how to address it.

  • finding_type(Option<FindingType>):

    The type of the finding. For external access analyzers, the type is ExternalAccess. For unused access analyzers, the type can be UnusedIAMRole, UnusedIAMUserAccessKey, UnusedIAMUserPassword, or UnusedPermission.

• On failure, responds with SdkError<GetFindingV2Error>

Constructs a fluent builder for the GetFindingsStatistics operation.

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

    The ARN of the analyzer used to generate the statistics.

    
    
• On success, responds with GetFindingsStatisticsOutput with field(s):
  • findings_statistics(Option<Vec::<FindingsStatistics>>):

    A group of external access or unused access findings statistics.

  • last_updated_at(Option<DateTime>):

    The time at which the retrieval of the findings statistics was last updated. If the findings statistics have not been previously retrieved for the specified analyzer, this field will not be populated.

• On failure, responds with SdkError<GetFindingsStatisticsError>

Constructs a fluent builder for the GetGeneratedPolicy operation.

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

    The JobId that is returned by the StartPolicyGeneration operation. The JobId can be used with GetGeneratedPolicy to retrieve the generated policies or used with CancelPolicyGeneration to cancel the policy generation request.

    
    
  • include_resource_placeholders(bool) / set_include_resource_placeholders(Option<bool>):
    required: false
    

    The level of detail that you want to generate. You can specify whether to generate policies with placeholders for resource ARNs for actions that support resource level granularity in policies.

    For example, in the resource section of a policy, you can receive a placeholder such as “Resource”:“arn:aws:s3:::${BucketName}” instead of “*”.

    
    
  • include_service_level_template(bool) / set_include_service_level_template(Option<bool>):
    required: false
    

    The level of detail that you want to generate. You can specify whether to generate service-level policies.

    IAM Access Analyzer uses iam:servicelastaccessed to identify services that have been used recently to create this service-level template.

    
    
• On success, responds with GetGeneratedPolicyOutput with field(s):
  • job_details(Option<JobDetails>):

    A GeneratedPolicyDetails object that contains details about the generated policy.

  • generated_policy_result(Option<GeneratedPolicyResult>):

    A GeneratedPolicyResult object that contains the generated policies and associated details.

• On failure, responds with SdkError<GetGeneratedPolicyError>

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

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

    The unique ID for the access preview.

    
    
  • analyzer_arn(impl Into<String>) / set_analyzer_arn(Option<String>):
    required: true
    

    The ARN of the analyzer used to generate the access.

    
    
  • filter(impl Into<String>, Criterion) / set_filter(Option<HashMap::<String, Criterion>>):
    required: false
    

    Criteria to filter the returned findings.

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

    A token used for pagination of results returned.

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

    The maximum number of results to return in the response.

    
    
• On success, responds with ListAccessPreviewFindingsOutput with field(s):
  • findings(Vec::<AccessPreviewFinding>):

    A list of access preview findings that match the specified filter criteria.

  • next_token(Option<String>):

    A token used for pagination of results returned.

• On failure, responds with SdkError<ListAccessPreviewFindingsError>

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

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

    The ARN of the analyzer used to generate the access preview.

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

    A token used for pagination of results returned.

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

    The maximum number of results to return in the response.

    
    
• On success, responds with ListAccessPreviewsOutput with field(s):
  • access_previews(Vec::<AccessPreviewSummary>):

    A list of access previews retrieved for the analyzer.

  • next_token(Option<String>):

    A token used for pagination of results returned.

• On failure, responds with SdkError<ListAccessPreviewsError>

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

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

    The ARN of the analyzer to retrieve a list of analyzed resources from.

    
    
  • resource_type(ResourceType) / set_resource_type(Option<ResourceType>):
    required: false
    

    The type of resource.

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

    A token used for pagination of results returned.

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

    The maximum number of results to return in the response.

    
    
• On success, responds with ListAnalyzedResourcesOutput with field(s):
  • analyzed_resources(Vec::<AnalyzedResourceSummary>):

    A list of resources that were analyzed.

  • next_token(Option<String>):

    A token used for pagination of results returned.

• On failure, responds with SdkError<ListAnalyzedResourcesError>

Constructs a fluent builder for the ListAnalyzers 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
    

    A token used for pagination of results returned.

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

    The maximum number of results to return in the response.

    
    
  • r#type(Type) / set_type(Option<Type>):
    required: false
    

    The type of analyzer.

    
    
• On success, responds with ListAnalyzersOutput with field(s):
  • analyzers(Vec::<AnalyzerSummary>):

    The analyzers retrieved.

  • next_token(Option<String>):

    A token used for pagination of results returned.

• On failure, responds with SdkError<ListAnalyzersError>

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

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

    The name of the analyzer to retrieve rules from.

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

    A token used for pagination of results returned.

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

    The maximum number of results to return in the request.

    
    
• On success, responds with ListArchiveRulesOutput with field(s):
  • archive_rules(Vec::<ArchiveRuleSummary>):

    A list of archive rules created for the specified analyzer.

  • next_token(Option<String>):

    A token used for pagination of results returned.

• On failure, responds with SdkError<ListArchiveRulesError>

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

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

    The ARN of the analyzer to retrieve findings from.

    
    
  • filter(impl Into<String>, Criterion) / set_filter(Option<HashMap::<String, Criterion>>):
    required: false
    

    A filter to match for the findings to return.

    
    
  • sort(SortCriteria) / set_sort(Option<SortCriteria>):
    required: false
    

    The sort order for the findings returned.

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

    A token used for pagination of results returned.

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

    The maximum number of results to return in the response.

    
    
• On success, responds with ListFindingsOutput with field(s):
  • findings(Vec::<FindingSummary>):

    A list of findings retrieved from the analyzer that match the filter criteria specified, if any.

  • next_token(Option<String>):

    A token used for pagination of results returned.

• On failure, responds with SdkError<ListFindingsError>

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

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

    The ARN of the analyzer to retrieve findings from.

    
    
  • filter(impl Into<String>, Criterion) / set_filter(Option<HashMap::<String, Criterion>>):
    required: false
    

    A filter to match for the findings to return.

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

    The maximum number of results to return in the response.

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

    A token used for pagination of results returned.

    
    
  • sort(SortCriteria) / set_sort(Option<SortCriteria>):
    required: false
    

    The criteria used to sort.

    
    
• On success, responds with ListFindingsV2Output with field(s):
  • findings(Vec::<FindingSummaryV2>):

    A list of findings retrieved from the analyzer that match the filter criteria specified, if any.

  • next_token(Option<String>):

    A token used for pagination of results returned.

• On failure, responds with SdkError<ListFindingsV2Error>

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

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

    The ARN of the IAM entity (user or role) for which you are generating a policy. Use this with ListGeneratedPolicies to filter the results to only include results for a specific principal.

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

    The maximum number of results to return in the response.

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

    A token used for pagination of results returned.

    
    
• On success, responds with ListPolicyGenerationsOutput with field(s):
  • policy_generations(Vec::<PolicyGeneration>):

    A PolicyGeneration object that contains details about the generated policy.

  • next_token(Option<String>):

    A token used for pagination of results returned.

• On failure, responds with SdkError<ListPolicyGenerationsError>

Constructs a fluent builder for the ListTagsForResource operation.

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

    The ARN of the resource to retrieve tags from.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap::<String, String>>):

    The tags that are applied to the specified resource.

• On failure, responds with SdkError<ListTagsForResourceError>

Constructs a fluent builder for the StartPolicyGeneration operation.

• The fluent builder is configurable:
  • policy_generation_details(PolicyGenerationDetails) / set_policy_generation_details(Option<PolicyGenerationDetails>):
    required: true
    

    Contains the ARN of the IAM entity (user or role) for which you are generating a policy.

    
    
  • cloud_trail_details(CloudTrailDetails) / set_cloud_trail_details(Option<CloudTrailDetails>):
    required: false
    

    A CloudTrailDetails object that contains details about a Trail that you want to analyze to generate policies.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect.

    If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

    
    
• On success, responds with StartPolicyGenerationOutput with field(s):
  • job_id(String):

    The JobId that is returned by the StartPolicyGeneration operation. The JobId can be used with GetGeneratedPolicy to retrieve the generated policies or used with CancelPolicyGeneration to cancel the policy generation request.

• On failure, responds with SdkError<StartPolicyGenerationError>

Constructs a fluent builder for the StartResourceScan operation.

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

    The ARN of the analyzer to use to scan the policies applied to the specified resource.

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

    The ARN of the resource to scan.

    
    
  • resource_owner_account(impl Into<String>) / set_resource_owner_account(Option<String>):
    required: false
    

    The Amazon Web Services account ID that owns the resource. For most Amazon Web Services resources, the owning account is the account in which the resource was created.

    
    
• On success, responds with StartResourceScanOutput
• On failure, responds with SdkError<StartResourceScanError>

Constructs a fluent builder for the TagResource operation.

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

    The ARN of the resource to add the tag to.

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

    The tags to add to the resource.

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

Constructs a fluent builder for the UntagResource operation.

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

    The ARN of the resource to remove the tag from.

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

    The key for the tag to add.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

Constructs a fluent builder for the UpdateAnalyzer operation.

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

    The name of the analyzer to modify.

    
    
  • configuration(AnalyzerConfiguration) / set_configuration(Option<AnalyzerConfiguration>):
    required: false
    

    Contains information about the configuration of an analyzer for an Amazon Web Services organization or account.

    
    
• On success, responds with UpdateAnalyzerOutput with field(s):
  • configuration(Option<AnalyzerConfiguration>):

    Contains information about the configuration of an analyzer for an Amazon Web Services organization or account.

• On failure, responds with SdkError<UpdateAnalyzerError>

Constructs a fluent builder for the UpdateArchiveRule operation.

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

    The name of the analyzer to update the archive rules for.

    
    
  • rule_name(impl Into<String>) / set_rule_name(Option<String>):
    required: true
    

    The name of the rule to update.

    
    
  • filter(impl Into<String>, Criterion) / set_filter(Option<HashMap::<String, Criterion>>):
    required: true
    

    A filter to match for the rules to update. Only rules that match the filter are updated.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A client token.

    
    
• On success, responds with UpdateArchiveRuleOutput
• On failure, responds with SdkError<UpdateArchiveRuleError>

Constructs a fluent builder for the UpdateFindings operation.

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

    The ARN of the analyzer that generated the findings to update.

    
    
  • status(FindingStatusUpdate) / set_status(Option<FindingStatusUpdate>):
    required: true
    

    The state represents the action to take to update the finding Status. Use ARCHIVE to change an Active finding to an Archived finding. Use ACTIVE to change an Archived finding to an Active finding.

    
    
  • ids(impl Into<String>) / set_ids(Option<Vec::<String>>):
    required: false
    

    The IDs of the findings to update.

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

    The ARN of the resource identified in the finding.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A client token.

    
    
• On success, responds with UpdateFindingsOutput
• On failure, responds with SdkError<UpdateFindingsError>

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

• The fluent builder is configurable:
  • locale(Locale) / set_locale(Option<Locale>):
    required: false
    

    The locale to use for localizing the findings.

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

    The maximum number of results to return in the response.

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

    A token used for pagination of results returned.

    
    
  • policy_document(impl Into<String>) / set_policy_document(Option<String>):
    required: true
    

    The JSON policy document to use as the content for the policy.

    
    
  • policy_type(PolicyType) / set_policy_type(Option<PolicyType>):
    required: true
    

    The type of policy to validate. Identity policies grant permissions to IAM principals. Identity policies include managed and inline policies for IAM roles, users, and groups.

    Resource policies grant permissions on Amazon Web Services resources. Resource policies include trust policies for IAM roles and bucket policies for Amazon S3 buckets. You can provide a generic input such as identity policy or resource policy or a specific input such as managed policy or Amazon S3 bucket policy.

    Service control policies (SCPs) are a type of organization policy attached to an Amazon Web Services organization, organizational unit (OU), or an account.

    
    
  • validate_policy_resource_type(ValidatePolicyResourceType) / set_validate_policy_resource_type(Option<ValidatePolicyResourceType>):
    required: false
    

    The type of resource to attach to your resource policy. Specify a value for the policy validation resource type only if the policy type is RESOURCE_POLICY. For example, to validate a resource policy to attach to an Amazon S3 bucket, you can choose AWS::S3::Bucket for the policy validation resource type.

    For resource types not supported as valid values, IAM Access Analyzer runs policy checks that apply to all resource policies. For example, to validate a resource policy to attach to a KMS key, do not specify a value for the policy validation resource type and IAM Access Analyzer will run policy checks that apply to all resource policies.

    
    
• On success, responds with ValidatePolicyOutput with field(s):
  • findings(Vec::<ValidatePolicyFinding>):

    The list of findings in a policy returned by IAM Access Analyzer based on its suite of policy checks.

  • next_token(Option<String>):

    A token used for pagination of results returned.

• On failure, responds with SdkError<ValidatePolicyError>

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.

Returns the client’s configuration.

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.

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Returns a styled value derived from self with the foreground set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like red() and green(), which have the same functionality but are pithier.

§Example

Set foreground color to white using fg():

use yansi::{Paint, Color};

painted.fg(Color::White);

Set foreground color to white using white().

use yansi::Paint;

painted.white();

Returns self with the fg() set to [Color :: Primary].

§Example

println!("{}", value.primary());

Returns self with the fg() set to [Color :: Fixed].

§Example

println!("{}", value.fixed(color));

Returns self with the fg() set to [Color :: Rgb].

§Example

println!("{}", value.rgb(r, g, b));

Returns self with the fg() set to [Color :: Black].

§Example

println!("{}", value.black());

Returns self with the fg() set to [Color :: Red].

§Example

println!("{}", value.red());

Returns self with the fg() set to [Color :: Green].

§Example

println!("{}", value.green());

Returns self with the fg() set to [Color :: Yellow].

§Example

println!("{}", value.yellow());

Returns self with the fg() set to [Color :: Blue].

§Example

println!("{}", value.blue());

Returns self with the fg() set to [Color :: Magenta].

§Example

println!("{}", value.magenta());

Returns self with the fg() set to [Color :: Cyan].

§Example

println!("{}", value.cyan());

Returns self with the fg() set to [Color :: White].

§Example

println!("{}", value.white());

Returns self with the fg() set to [Color :: BrightBlack].

§Example

println!("{}", value.bright_black());

Returns self with the fg() set to [Color :: BrightRed].

§Example

println!("{}", value.bright_red());

Returns self with the fg() set to [Color :: BrightGreen].

§Example

println!("{}", value.bright_green());

Returns self with the fg() set to [Color :: BrightYellow].

§Example

println!("{}", value.bright_yellow());

Returns self with the fg() set to [Color :: BrightBlue].

§Example

println!("{}", value.bright_blue());

Returns self with the fg() set to [Color :: BrightMagenta].

§Example

println!("{}", value.bright_magenta());

Returns self with the fg() set to [Color :: BrightCyan].

§Example

println!("{}", value.bright_cyan());

Returns self with the fg() set to [Color :: BrightWhite].

§Example

println!("{}", value.bright_white());

Returns a styled value derived from self with the background set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like on_red() and on_green(), which have the same functionality but are pithier.

§Example

Set background color to red using fg():

use yansi::{Paint, Color};

painted.bg(Color::Red);

Set background color to red using on_red().

use yansi::Paint;

painted.on_red();

Returns self with the bg() set to [Color :: Primary].

§Example

println!("{}", value.on_primary());

Returns self with the bg() set to [Color :: Fixed].

§Example

println!("{}", value.on_fixed(color));

Returns self with the bg() set to [Color :: Rgb].

§Example

println!("{}", value.on_rgb(r, g, b));

Returns self with the bg() set to [Color :: Black].

§Example

println!("{}", value.on_black());

Returns self with the bg() set to [Color :: Red].

§Example

println!("{}", value.on_red());

Returns self with the bg() set to [Color :: Green].

§Example

println!("{}", value.on_green());

Returns self with the bg() set to [Color :: Yellow].

§Example

println!("{}", value.on_yellow());

Returns self with the bg() set to [Color :: Blue].

§Example

println!("{}", value.on_blue());

Returns self with the bg() set to [Color :: Magenta].

§Example

println!("{}", value.on_magenta());

Returns self with the bg() set to [Color :: Cyan].

§Example

println!("{}", value.on_cyan());

Returns self with the bg() set to [Color :: White].

§Example

println!("{}", value.on_white());

Returns self with the bg() set to [Color :: BrightBlack].

§Example

println!("{}", value.on_bright_black());

Returns self with the bg() set to [Color :: BrightRed].

§Example

println!("{}", value.on_bright_red());

Returns self with the bg() set to [Color :: BrightGreen].

§Example

println!("{}", value.on_bright_green());

Returns self with the bg() set to [Color :: BrightYellow].

§Example

println!("{}", value.on_bright_yellow());

Returns self with the bg() set to [Color :: BrightBlue].

§Example

println!("{}", value.on_bright_blue());

Returns self with the bg() set to [Color :: BrightMagenta].

§Example

println!("{}", value.on_bright_magenta());

Returns self with the bg() set to [Color :: BrightCyan].

§Example

println!("{}", value.on_bright_cyan());

Returns self with the bg() set to [Color :: BrightWhite].

§Example

println!("{}", value.on_bright_white());

Enables the styling Attribute value.

This method should be used rarely. Instead, prefer to use attribute-specific builder methods like bold() and underline(), which have the same functionality but are pithier.

§Example

Make text bold using attr():

use yansi::{Paint, Attribute};

painted.attr(Attribute::Bold);

Make text bold using using bold().

use yansi::Paint;

painted.bold();

Returns self with the attr() set to [Attribute :: Bold].

§Example

println!("{}", value.bold());

Returns self with the attr() set to [Attribute :: Dim].

§Example

println!("{}", value.dim());

Returns self with the attr() set to [Attribute :: Italic].

§Example

println!("{}", value.italic());

Returns self with the attr() set to [Attribute :: Underline].

§Example

println!("{}", value.underline());

Returns self with the attr() set to [Attribute :: Blink].

§Example

println!("{}", value.blink());

Returns self with the attr() set to [Attribute :: RapidBlink].

§Example

println!("{}", value.rapid_blink());

Returns self with the attr() set to [Attribute :: Invert].

§Example

println!("{}", value.invert());

Returns self with the attr() set to [Attribute :: Conceal].

§Example

println!("{}", value.conceal());

Returns self with the attr() set to [Attribute :: Strike].

§Example

println!("{}", value.strike());

Enables the yansi Quirk value.

This method should be used rarely. Instead, prefer to use quirk-specific builder methods like mask() and wrap(), which have the same functionality but are pithier.

§Example

Enable wrapping using .quirk():

use yansi::{Paint, Quirk};

painted.quirk(Quirk::Wrap);

Enable wrapping using wrap().

use yansi::Paint;

painted.wrap();

Returns self with the quirk() set to [Quirk :: Mask].

§Example

println!("{}", value.mask());

Returns self with the quirk() set to [Quirk :: Wrap].

§Example

println!("{}", value.wrap());

Returns self with the quirk() set to [Quirk :: Linger].

§Example

println!("{}", value.linger());

Returns self with the quirk() set to [Quirk :: Clear].

§Example

println!("{}", value.clear());

Returns self with the quirk() set to [Quirk :: Resetting].

§Example

println!("{}", value.resetting());

Returns self with the quirk() set to [Quirk :: Bright].

§Example

println!("{}", value.bright());

Returns self with the quirk() set to [Quirk :: OnBright].

§Example

println!("{}", value.on_bright());

Conditionally enable styling based on whether the Condition value applies. Replaces any previous condition.

See the crate level docs for more details.

§Example

Enable styling painted only when both stdout and stderr are TTYs:

use yansi::{Paint, Condition};

painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);