Struct aws_sdk_connectcases::client::Client

source · [−]

pub struct Client { /* private fields */ }

Expand description

Client for Amazon Connect Cases

Client for invoking operations on Amazon Connect Cases. Each operation on Amazon Connect Cases is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_connectcases::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::retry::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_connectcases::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_connectcases::Client::from_conf(config);

Implementations

source

impl Client

source

pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self

Creates a client with the given service configuration.

source

pub fn conf(&self) -> &Config

Returns the client’s configuration.

source

impl Client

source

pub fn batch_get_field(&self) -> BatchGetField

Constructs a fluent builder for the BatchGetField operation.

The fluent builder is configurable:
- domain_id(impl Into<String>) / set_domain_id(Option<String>):
 The unique identifier of the Cases domain.
- fields(Vec<FieldIdentifier>) / set_fields(Option<Vec<FieldIdentifier>>):
 A list of unique field identifiers.
On success, responds with BatchGetFieldOutput with field(s):
- fields(Option<Vec<GetFieldResponse>>):
 A list of detailed field information.
- errors(Option<Vec<FieldError>>):
 A list of field errors.
On failure, responds with SdkError<BatchGetFieldError>

source

pub fn batch_put_field_options(&self) -> BatchPutFieldOptions

Constructs a fluent builder for the BatchPutFieldOptions operation.

The fluent builder is configurable:
- domain_id(impl Into<String>) / set_domain_id(Option<String>):
 The unique identifier of the Cases domain.
- field_id(impl Into<String>) / set_field_id(Option<String>):
 The unique identifier of a field.
- options(Vec<FieldOption>) / set_options(Option<Vec<FieldOption>>):
 A list of FieldOption objects.
On success, responds with BatchPutFieldOptionsOutput with field(s):
- errors(Option<Vec<FieldOptionError>>):
 A list of field errors.
On failure, responds with SdkError<BatchPutFieldOptionsError>

source

pub fn create_case(&self) -> CreateCase

Constructs a fluent builder for the CreateCase operation.

The fluent builder is configurable:
- domain_id(impl Into<String>) / set_domain_id(Option<String>):
 The unique identifier of the Cases domain.
- template_id(impl Into<String>) / set_template_id(Option<String>):
 A unique identifier of a template.
- fields(Vec<FieldValue>) / set_fields(Option<Vec<FieldValue>>):
 An array of objects with field ID (matching ListFields/DescribeField) and value union data.
- client_token(impl Into<String>) / set_client_token(Option<String>):
 A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
On success, responds with CreateCaseOutput with field(s):
- case_id(Option<String>):
 A unique identifier of the case.
- case_arn(Option<String>):
 The Amazon Resource Name (ARN) of the case.
On failure, responds with SdkError<CreateCaseError>

source

pub fn create_domain(&self) -> CreateDomain

Constructs a fluent builder for the CreateDomain operation.

The fluent builder is configurable:
- name(impl Into<String>) / set_name(Option<String>):
 The name for your Cases domain. It must be unique for your Amazon Web Services account.
On success, responds with CreateDomainOutput with field(s):
- domain_id(Option<String>):
 The unique identifier of the Cases domain.
- domain_arn(Option<String>):
 The Amazon Resource Name (ARN) for the Cases domain.
- domain_status(Option<DomainStatus>):
 The status of the domain.
On failure, responds with SdkError<CreateDomainError>

source

pub fn create_field(&self) -> CreateField

Constructs a fluent builder for the CreateField operation.

The fluent builder is configurable:
- domain_id(impl Into<String>) / set_domain_id(Option<String>):
 The unique identifier of the Cases domain.
- name(impl Into<String>) / set_name(Option<String>):
 The name of the field.
- r#type(FieldType) / set_type(Option<FieldType>):
 Defines the data type, some system constraints, and default display of the field.
- description(impl Into<String>) / set_description(Option<String>):
 The description of the field.
On success, responds with CreateFieldOutput with field(s):
- field_id(Option<String>):
 The unique identifier of a field.
- field_arn(Option<String>):
 The Amazon Resource Name (ARN) of the field.
On failure, responds with SdkError<CreateFieldError>

source

pub fn create_layout(&self) -> CreateLayout

Constructs a fluent builder for the CreateLayout operation.

The fluent builder is configurable:
- domain_id(impl Into<String>) / set_domain_id(Option<String>):
 The unique identifier of the Cases domain.
- name(impl Into<String>) / set_name(Option<String>):
 The name of the layout. It must be unique for the Cases domain.
- content(LayoutContent) / set_content(Option<LayoutContent>):
 Information about which fields will be present in the layout, and information about the order of the fields.
On success, responds with CreateLayoutOutput with field(s):
- layout_id(Option<String>):
 The unique identifier of the layout.
- layout_arn(Option<String>):
 The Amazon Resource Name (ARN) of the newly created layout.
On failure, responds with SdkError<CreateLayoutError>

source

pub fn create_related_item(&self) -> CreateRelatedItem

Constructs a fluent builder for the CreateRelatedItem operation.

The fluent builder is configurable:
- domain_id(impl Into<String>) / set_domain_id(Option<String>):
 The unique identifier of the Cases domain.
- case_id(impl Into<String>) / set_case_id(Option<String>):
 A unique identifier of the case.
- r#type(RelatedItemType) / set_type(Option<RelatedItemType>):
 The type of a related item.
- content(RelatedItemInputContent) / set_content(Option<RelatedItemInputContent>):
 The content of a related item to be created.
On success, responds with CreateRelatedItemOutput with field(s):
- related_item_id(Option<String>):
 The unique identifier of the related item.
- related_item_arn(Option<String>):
 The Amazon Resource Name (ARN) of the related item.
On failure, responds with SdkError<CreateRelatedItemError>

source

pub fn create_template(&self) -> CreateTemplate

Constructs a fluent builder for the CreateTemplate operation.

The fluent builder is configurable:
- domain_id(impl Into<String>) / set_domain_id(Option<String>):
 The unique identifier of the Cases domain.
- name(impl Into<String>) / set_name(Option<String>):
 A name for the template. It must be unique per domain.
- description(impl Into<String>) / set_description(Option<String>):
 A brief description of the template.
- layout_configuration(LayoutConfiguration) / set_layout_configuration(Option<LayoutConfiguration>):
 Configuration of layouts associated to the template.
- required_fields(Vec<RequiredField>) / set_required_fields(Option<Vec<RequiredField>>):
 A list of fields that must contain a value for a case to be successfully created with this template.
On success, responds with CreateTemplateOutput with field(s):
- template_id(Option<String>):
 A unique identifier of a template.
- template_arn(Option<String>):
 The Amazon Resource Name (ARN) of the newly created template.
On failure, responds with SdkError<CreateTemplateError>

source

pub fn get_case(&self) -> GetCase

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

The fluent builder is configurable:
- case_id(impl Into<String>) / set_case_id(Option<String>):
 A unique identifier of the case.
- domain_id(impl Into<String>) / set_domain_id(Option<String>):
 The unique identifier of the Cases domain.
- fields(Vec<FieldIdentifier>) / set_fields(Option<Vec<FieldIdentifier>>):
 A list of unique field identifiers.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
On success, responds with GetCaseOutput with field(s):
- fields(Option<Vec<FieldValue>>):
 A list of detailed field information.
- template_id(Option<String>):
 A unique identifier of a template.
- next_token(Option<String>):
 The token for the next set of results. This is null if there are no more results to return.
- tags(Option<HashMap<String, Option<String>>>):
 A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
On failure, responds with SdkError<GetCaseError>

source

pub fn get_case_event_configuration(&self) -> GetCaseEventConfiguration

Constructs a fluent builder for the GetCaseEventConfiguration operation.

The fluent builder is configurable:
- domain_id(impl Into<String>) / set_domain_id(Option<String>):
 The unique identifier of the Cases domain.
On success, responds with GetCaseEventConfigurationOutput with field(s):
- event_bridge(Option<EventBridgeConfiguration>):
 Configuration to enable EventBridge case event delivery and determine what data is delivered.
On failure, responds with SdkError<GetCaseEventConfigurationError>

source

pub fn get_domain(&self) -> GetDomain

Constructs a fluent builder for the GetDomain operation.

The fluent builder is configurable:
- domain_id(impl Into<String>) / set_domain_id(Option<String>):
 The unique identifier of the Cases domain.
On success, responds with GetDomainOutput with field(s):
- domain_id(Option<String>):
 The unique identifier of the Cases domain.
- domain_arn(Option<String>):
 The Amazon Resource Name (ARN) for the Cases domain.
- name(Option<String>):
 The name of the Cases domain.
- created_time(Option<DateTime>):
 The timestamp when the Cases domain was created.
- domain_status(Option<DomainStatus>):
 The status of the Cases domain.
- tags(Option<HashMap<String, Option<String>>>):
 A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
On failure, responds with SdkError<GetDomainError>

source

pub fn get_layout(&self) -> GetLayout

Constructs a fluent builder for the GetLayout operation.

The fluent builder is configurable:
- domain_id(impl Into<String>) / set_domain_id(Option<String>):
 The unique identifier of the Cases domain.
- layout_id(impl Into<String>) / set_layout_id(Option<String>):
 The unique identifier of the layout.
On success, responds with GetLayoutOutput with field(s):
- layout_id(Option<String>):
 The unique identifier of the layout.
- layout_arn(Option<String>):
 The Amazon Resource Name (ARN) of the newly created layout.
- name(Option<String>):
 The name of the layout. It must be unique.
- content(Option<LayoutContent>):
 Information about which fields will be present in the layout, the order of the fields, and read-only attribute of the field.
- tags(Option<HashMap<String, Option<String>>>):
 A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
On failure, responds with SdkError<GetLayoutError>

source

pub fn get_template(&self) -> GetTemplate

Constructs a fluent builder for the GetTemplate operation.

The fluent builder is configurable:
- domain_id(impl Into<String>) / set_domain_id(Option<String>):
 The unique identifier of the Cases domain.
- template_id(impl Into<String>) / set_template_id(Option<String>):
 A unique identifier of a template.
On success, responds with GetTemplateOutput with field(s):
- template_id(Option<String>):
 A unique identifier of a template.
- template_arn(Option<String>):
 The Amazon Resource Name (ARN) of the template.
- name(Option<String>):
 The name of the template.
- description(Option<String>):
 A brief description of the template.
- layout_configuration(Option<LayoutConfiguration>):
 Configuration of layouts associated to the template.
- required_fields(Option<Vec<RequiredField>>):
 A list of fields that must contain a value for a case to be successfully created with this template.
- tags(Option<HashMap<String, Option<String>>>):
 A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
On failure, responds with SdkError<GetTemplateError>

source

pub fn list_cases_for_contact(&self) -> ListCasesForContact

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

The fluent builder is configurable:
- domain_id(impl Into<String>) / set_domain_id(Option<String>):
 The unique identifier of the Cases domain.
- contact_arn(impl Into<String>) / set_contact_arn(Option<String>):
 A unique identifier of a contact in Amazon Connect.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum number of results to return per page.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
On success, responds with ListCasesForContactOutput with field(s):
- cases(Option<Vec<CaseSummary>>):
 A list of Case summary information.
- next_token(Option<String>):
 The token for the next set of results. This is null if there are no more results to return.
On failure, responds with SdkError<ListCasesForContactError>

source

pub fn list_domains(&self) -> ListDomains

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>):
 The maximum number of results to return per page.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
On success, responds with ListDomainsOutput with field(s):
- domains(Option<Vec<DomainSummary>>):
 The Cases domain.
- next_token(Option<String>):
 The token for the next set of results. This is null if there are no more results to return.
On failure, responds with SdkError<ListDomainsError>

source

pub fn list_field_options(&self) -> ListFieldOptions

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

The fluent builder is configurable:
- domain_id(impl Into<String>) / set_domain_id(Option<String>):
 The unique identifier of the Cases domain.
- field_id(impl Into<String>) / set_field_id(Option<String>):
 The unique identifier of a field.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum number of results to return per page.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
- values(Vec<String>) / set_values(Option<Vec<String>>):
 A list of FieldOption values to filter on for ListFieldOptions.
On success, responds with ListFieldOptionsOutput with field(s):
- options(Option<Vec<FieldOption>>):
 A list of FieldOption objects.
- next_token(Option<String>):
 The token for the next set of results. This is null if there are no more results to return.
On failure, responds with SdkError<ListFieldOptionsError>

source

pub fn list_fields(&self) -> ListFields

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

The fluent builder is configurable:
- domain_id(impl Into<String>) / set_domain_id(Option<String>):
 The unique identifier of the Cases domain.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum number of results to return per page.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
On success, responds with ListFieldsOutput with field(s):
- fields(Option<Vec<FieldSummary>>):
 List of detailed field information.
- next_token(Option<String>):
 The token for the next set of results. This is null if there are no more results to return.
On failure, responds with SdkError<ListFieldsError>

source

pub fn list_layouts(&self) -> ListLayouts

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

The fluent builder is configurable:
- domain_id(impl Into<String>) / set_domain_id(Option<String>):
 The unique identifier of the Cases domain.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum number of results to return per page.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
On success, responds with ListLayoutsOutput with field(s):
- layouts(Option<Vec<LayoutSummary>>):
 The layouts for the domain.
- next_token(Option<String>):
 The token for the next set of results. This is null if there are no more results to return.
On failure, responds with SdkError<ListLayoutsError>

source

pub fn list_tags_for_resource(&self) -> ListTagsForResource

Constructs a fluent builder for the ListTagsForResource operation.

The fluent builder is configurable:
- arn(impl Into<String>) / set_arn(Option<String>):
 The Amazon Resource Name (ARN)
On success, responds with ListTagsForResourceOutput with field(s):
- tags(Option<HashMap<String, Option<String>>>):
 A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
On failure, responds with SdkError<ListTagsForResourceError>

source

pub fn list_templates(&self) -> ListTemplates

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

The fluent builder is configurable:
- domain_id(impl Into<String>) / set_domain_id(Option<String>):
 The unique identifier of the Cases domain.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum number of results to return per page.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
On success, responds with ListTemplatesOutput with field(s):
- templates(Option<Vec<TemplateSummary>>):
 List of template summary objects.
- next_token(Option<String>):
 The token for the next set of results. This is null if there are no more results to return.
On failure, responds with SdkError<ListTemplatesError>

source

pub fn put_case_event_configuration(&self) -> PutCaseEventConfiguration

Constructs a fluent builder for the PutCaseEventConfiguration operation.

The fluent builder is configurable:
- domain_id(impl Into<String>) / set_domain_id(Option<String>):
 The unique identifier of the Cases domain.
- event_bridge(EventBridgeConfiguration) / set_event_bridge(Option<EventBridgeConfiguration>):
 Configuration to enable EventBridge case event delivery and determine what data is delivered.
On success, responds with PutCaseEventConfigurationOutput
On failure, responds with SdkError<PutCaseEventConfigurationError>

source

pub fn search_cases(&self) -> SearchCases

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

The fluent builder is configurable:
- domain_id(impl Into<String>) / set_domain_id(Option<String>):
 The unique identifier of the Cases domain.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum number of cases to return. The current maximum supported value is 25. This is also the default value when no other value is provided.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
- search_term(impl Into<String>) / set_search_term(Option<String>):
 A word or phrase used to perform a quick search.
- filter(CaseFilter) / set_filter(Option<CaseFilter>):
 A list of filter objects.
- sorts(Vec<Sort>) / set_sorts(Option<Vec<Sort>>):
 A list of sorts where each sort specifies a field and their sort order to be applied to the results.
- fields(Vec<FieldIdentifier>) / set_fields(Option<Vec<FieldIdentifier>>):
 The list of field identifiers to be returned as part of the response.
On success, responds with SearchCasesOutput with field(s):
- next_token(Option<String>):
 The token for the next set of results. This is null if there are no more results to return.
- cases(Option<Vec<Option<SearchCasesResponseItem>>>):
 A list of case documents where each case contains the properties CaseId and Fields where each field is a complex union structure.
On failure, responds with SdkError<SearchCasesError>