Struct Client 

pub struct Client { /* private fields */ }

Client for AWS Control Catalog

Client for invoking operations on AWS Control Catalog. Each operation on AWS Control Catalog 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_controlcatalog::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_controlcatalog::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 GetControl operation has a Client::get_control, 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.get_control()
    .control_arn("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 get_control(&self) -> GetControlFluentBuilder

Constructs a fluent builder for the GetControl operation.

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

    The Amazon Resource Name (ARN) of the control. It has one of the following formats:

    Global format

    arn:{PARTITION}:controlcatalog:::control/{CONTROL_CATALOG_OPAQUE_ID}

    Or Regional format

    arn:{PARTITION}:controltower:{REGION}::control/{CONTROL_TOWER_OPAQUE_ID}

    Here is a more general pattern that covers Amazon Web Services Control Tower and Control Catalog ARNs:

    ^arn:(aws(?:[-a-z])?):(controlcatalog|controltower):[a-zA-Z0-9-]::control/[0-9a-zA-Z_\-]+$

    
    
• On success, responds with GetControlOutput with field(s):
  • arn(String):

    The Amazon Resource Name (ARN) of the control.

  • aliases(Option<Vec::<String>>):

    A list of alternative identifiers for the control. These are human-readable designators, such as SH.S3.1. Several aliases can refer to the same control across different Amazon Web Services services or compliance frameworks.

  • name(String):

    The display name of the control.

  • description(String):

    A description of what the control does.

  • behavior(ControlBehavior):

    A term that identifies the control’s functional behavior. One of Preventive, Detective, Proactive

  • severity(Option<ControlSeverity>):

    An enumerated type, with the following possible values:

  • region_configuration(Option<RegionConfiguration>):

    Returns information about the control, including the scope of the control, if enabled, and the Regions in which the control is available for deployment. For more information about scope, see Global services.

    If you are applying controls through an Amazon Web Services Control Tower landing zone environment, remember that the values returned in the RegionConfiguration API operation are not related to the governed Regions in your landing zone. For example, if you are governing Regions A,B,and C while the control is available in Regions A, B, C, and D, you’d see a response with DeployableRegions of A, B, C, and D for a control with REGIONAL scope, even though you may not intend to deploy the control in Region D, because you do not govern it through your landing zone.

  • implementation(Option<ImplementationDetails>):

    Returns information about the control, as an ImplementationDetails object that shows the underlying implementation type for a control.

  • parameters(Option<Vec::<ControlParameter>>):

    Returns an array of ControlParameter objects that specify the parameters a control supports. An empty list is returned for controls that don’t support parameters.

  • create_time(Option<DateTime>):

    A timestamp that notes the time when the control was released (start of its life) as a governance capability in Amazon Web Services.

  • governed_resources(Option<Vec::<String>>):

    A list of Amazon Web Services resource types that are governed by this control. This information helps you understand which controls can govern certain types of resources, and conversely, which resources are affected when the control is implemented. The resources are represented as Amazon Web Services CloudFormation resource types. If GovernedResources cannot be represented by available CloudFormation resource types, it’s returned as an empty list.

• On failure, responds with SdkError<GetControlError>

impl Client

pub fn list_common_controls(&self) -> ListCommonControlsFluentBuilder

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

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results on a page or for an API request call.

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

    The pagination token that’s used to fetch the next set of results.

    
    
  • common_control_filter(CommonControlFilter) / set_common_control_filter(Option<CommonControlFilter>):
    required: false
    

    An optional filter that narrows the results to a specific objective.

    This filter allows you to specify one objective ARN at a time. Passing multiple ARNs in the CommonControlFilter isn’t supported.

    
    
• On success, responds with ListCommonControlsOutput with field(s):
  • common_controls(Vec::<CommonControlSummary>):

    The list of common controls that the ListCommonControls API returns.

  • next_token(Option<String>):

    The pagination token that’s used to fetch the next set of results.

• On failure, responds with SdkError<ListCommonControlsError>

impl Client

pub fn list_control_mappings(&self) -> ListControlMappingsFluentBuilder

Constructs a fluent builder for the ListControlMappings 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 pagination token that’s used to fetch the next set of results.

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

    The maximum number of results on a page or for an API request call.

    
    
  • filter(ControlMappingFilter) / set_filter(Option<ControlMappingFilter>):
    required: false
    

    An optional filter that narrows the results to specific control mappings based on control ARNs, common control ARNs, or mapping types.

    
    
• On success, responds with ListControlMappingsOutput with field(s):
  • control_mappings(Vec::<ControlMapping>):

    The list of control mappings that the ListControlMappings API returns.

  • next_token(Option<String>):

    The pagination token that’s used to fetch the next set of results.

• On failure, responds with SdkError<ListControlMappingsError>

impl Client

pub fn list_controls(&self) -> ListControlsFluentBuilder

Constructs a fluent builder for the ListControls 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 pagination token that’s used to fetch the next set of results.

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

    The maximum number of results on a page or for an API request call.

    
    
  • filter(ControlFilter) / set_filter(Option<ControlFilter>):
    required: false
    

    An optional filter that narrows the results to controls with specific implementation types or identifiers. If you don’t provide a filter, the operation returns all available controls.

    
    
• On success, responds with ListControlsOutput with field(s):
  • controls(Vec::<ControlSummary>):

    Returns a list of controls, given as structures of type controlSummary.

  • next_token(Option<String>):

    The pagination token that’s used to fetch the next set of results.

• On failure, responds with SdkError<ListControlsError>

impl Client

pub fn list_domains(&self) -> ListDomainsFluentBuilder

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

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results on a page or for an API request call.

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

    The pagination token that’s used to fetch the next set of results.

    
    
• On success, responds with ListDomainsOutput with field(s):
  • domains(Vec::<DomainSummary>):

    The list of domains that the ListDomains API returns.

  • next_token(Option<String>):

    The pagination token that’s used to fetch the next set of results.

• On failure, responds with SdkError<ListDomainsError>

impl Client

pub fn list_objectives(&self) -> ListObjectivesFluentBuilder

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

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results on a page or for an API request call.

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

    The pagination token that’s used to fetch the next set of results.

    
    
  • objective_filter(ObjectiveFilter) / set_objective_filter(Option<ObjectiveFilter>):
    required: false
    

    An optional filter that narrows the results to a specific domain.

    This filter allows you to specify one domain ARN at a time. Passing multiple ARNs in the ObjectiveFilter isn’t supported.

    
    
• On success, responds with ListObjectivesOutput with field(s):
  • objectives(Vec::<ObjectiveSummary>):

    The list of objectives that the ListObjectives API returns.

  • next_token(Option<String>):

    The pagination token that’s used to fetch the next set of results.

• On failure, responds with SdkError<ListObjectivesError>

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.