pub struct Client { /* private fields */ }
Expand description
Client for Security Incident Response
Client for invoking operations on Security Incident Response. Each operation on Security Incident Response 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_securityir::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_securityir::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 BatchGetMemberAccountDetails
operation has
a Client::batch_get_member_account_details
, 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.batch_get_member_account_details()
.membership_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§
Source§impl Client
impl Client
Sourcepub fn batch_get_member_account_details(
&self,
) -> BatchGetMemberAccountDetailsFluentBuilder
pub fn batch_get_member_account_details( &self, ) -> BatchGetMemberAccountDetailsFluentBuilder
Constructs a fluent builder for the BatchGetMemberAccountDetails
operation.
- The fluent builder is configurable:
membership_id(impl Into<String>)
/set_membership_id(Option<String>)
:
required: trueRequired element used in combination with BatchGetMemberAccountDetails to identify the membership ID to query.
account_ids(impl Into<String>)
/set_account_ids(Option<Vec::<String>>)
:
required: trueOptional element to query the membership relationship status to a provided list of account IDs.
- On success, responds with
BatchGetMemberAccountDetailsOutput
with field(s):items(Option<Vec::<GetMembershipAccountDetailItem>>)
:The response element providing responses for requests to GetMembershipAccountDetails.
errors(Option<Vec::<GetMembershipAccountDetailError>>)
:The response element providing errors messages for requests to GetMembershipAccountDetails.
- On failure, responds with
SdkError<BatchGetMemberAccountDetailsError>
Source§impl Client
impl Client
Sourcepub fn cancel_membership(&self) -> CancelMembershipFluentBuilder
pub fn cancel_membership(&self) -> CancelMembershipFluentBuilder
Constructs a fluent builder for the CancelMembership
operation.
- The fluent builder is configurable:
membership_id(impl Into<String>)
/set_membership_id(Option<String>)
:
required: trueRequired element used in combination with CancelMembershipRequest to identify the membership ID to cancel.
- On success, responds with
CancelMembershipOutput
with field(s):membership_id(String)
:The response element providing responses for requests to CancelMembershipRequest.
- On failure, responds with
SdkError<CancelMembershipError>
Source§impl Client
impl Client
Sourcepub fn close_case(&self) -> CloseCaseFluentBuilder
pub fn close_case(&self) -> CloseCaseFluentBuilder
Constructs a fluent builder for the CloseCase
operation.
- The fluent builder is configurable:
case_id(impl Into<String>)
/set_case_id(Option<String>)
:
required: trueRequired element used in combination with CloseCase to identify the case ID to close.
- On success, responds with
CloseCaseOutput
with field(s):case_status(Option<CaseStatus>)
:A response element providing responses for requests to CloseCase. This element responds with the case status following the action.
closed_date(Option<DateTime>)
:A response element providing responses for requests to CloseCase. This element responds with the case closure date following the action.
- On failure, responds with
SdkError<CloseCaseError>
Source§impl Client
impl Client
Sourcepub fn create_case(&self) -> CreateCaseFluentBuilder
pub fn create_case(&self) -> CreateCaseFluentBuilder
Constructs a fluent builder for the CreateCase
operation.
- The fluent builder is configurable:
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseRequired element used in combination with CreateCase.
resolver_type(ResolverType)
/set_resolver_type(Option<ResolverType>)
:
required: trueRequired element used in combination with CreateCase to identify the resolver type. Available resolvers include self-supported | aws-supported.
title(impl Into<String>)
/set_title(Option<String>)
:
required: trueRequired element used in combination with CreateCase to provide a title for the new case.
description(impl Into<String>)
/set_description(Option<String>)
:
required: trueRequired element used in combination with CreateCase to provide a description for the new case.
engagement_type(EngagementType)
/set_engagement_type(Option<EngagementType>)
:
required: trueRequired element used in combination with CreateCase to provide an engagement type for the new cases. Available engagement types include Security Incident | Investigation
reported_incident_start_date(DateTime)
/set_reported_incident_start_date(Option<DateTime>)
:
required: trueRequired element used in combination with CreateCase to provide an initial start date for the unauthorized activity.
impacted_accounts(impl Into<String>)
/set_impacted_accounts(Option<Vec::<String>>)
:
required: trueRequired element used in combination with CreateCase to provide a list of impacted accounts.
watchers(Watcher)
/set_watchers(Option<Vec::<Watcher>>)
:
required: trueRequired element used in combination with CreateCase to provide a list of entities to receive notifications for case updates.
threat_actor_ip_addresses(ThreatActorIp)
/set_threat_actor_ip_addresses(Option<Vec::<ThreatActorIp>>)
:
required: falseAn optional element used in combination with CreateCase to provide a list of suspicious internet protocol addresses associated with unauthorized activity.
impacted_services(impl Into<String>)
/set_impacted_services(Option<Vec::<String>>)
:
required: falseAn optional element used in combination with CreateCase to provide a list of services impacted.
impacted_aws_regions(ImpactedAwsRegion)
/set_impacted_aws_regions(Option<Vec::<ImpactedAwsRegion>>)
:
required: falseAn optional element used in combination with CreateCase to provide a list of impacted regions.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseAn optional element used in combination with CreateCase to add customer specified tags to a case.
- On success, responds with
CreateCaseOutput
with field(s):case_id(String)
:A response element providing responses for requests to CreateCase. This element responds with the case ID.
- On failure, responds with
SdkError<CreateCaseError>
Source§impl Client
impl Client
Sourcepub fn create_case_comment(&self) -> CreateCaseCommentFluentBuilder
pub fn create_case_comment(&self) -> CreateCaseCommentFluentBuilder
Constructs a fluent builder for the CreateCaseComment
operation.
- The fluent builder is configurable:
case_id(impl Into<String>)
/set_case_id(Option<String>)
:
required: trueRequired element used in combination with CreateCaseComment to specify a case ID.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseAn optional element used in combination with CreateCaseComment.
body(impl Into<String>)
/set_body(Option<String>)
:
required: trueRequired element used in combination with CreateCaseComment to add content for the new comment.
- On success, responds with
CreateCaseCommentOutput
with field(s):comment_id(String)
:Response element indicating the new comment ID.
- On failure, responds with
SdkError<CreateCaseCommentError>
Source§impl Client
impl Client
Sourcepub fn create_membership(&self) -> CreateMembershipFluentBuilder
pub fn create_membership(&self) -> CreateMembershipFluentBuilder
Constructs a fluent builder for the CreateMembership
operation.
- The fluent builder is configurable:
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseAn optional element used in combination with CreateMembership.
membership_name(impl Into<String>)
/set_membership_name(Option<String>)
:
required: trueRequired element use in combination with CreateMembership to create a name for the membership.
incident_response_team(IncidentResponder)
/set_incident_response_team(Option<Vec::<IncidentResponder>>)
:
required: trueRequired element use in combination with CreateMembership to add customer incident response team members and trusted partners to the membership.
opt_in_features(OptInFeature)
/set_opt_in_features(Option<Vec::<OptInFeature>>)
:
required: falseOptional element to enable the monitoring and investigation opt-in features for the service.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseOptional element for customer configured tags.
- On success, responds with
CreateMembershipOutput
with field(s):membership_id(String)
:Response element for CreateMembership providing the newly created membership ID.
- On failure, responds with
SdkError<CreateMembershipError>
Source§impl Client
impl Client
Sourcepub fn get_case(&self) -> GetCaseFluentBuilder
pub fn get_case(&self) -> GetCaseFluentBuilder
Constructs a fluent builder for the GetCase
operation.
- The fluent builder is configurable:
case_id(impl Into<String>)
/set_case_id(Option<String>)
:
required: trueRequired element for GetCase to identify the requested case ID.
- On success, responds with
GetCaseOutput
with field(s):title(Option<String>)
:Response element for GetCase that provides the case title.
case_arn(Option<String>)
:Response element for GetCase that provides the case ARN
description(Option<String>)
:Response element for GetCase that provides contents of the case description.
case_status(Option<CaseStatus>)
:Response element for GetCase that provides the case status. Options for statuses include
Submitted | Detection and Analysis | Eradication, Containment and Recovery | Post-Incident Activities | Closed
engagement_type(Option<EngagementType>)
:Response element for GetCase that provides the engagement type. Options for engagement type include
Active Security Event | Investigations
reported_incident_start_date(Option<DateTime>)
:Response element for GetCase that provides the customer provided incident start date.
actual_incident_start_date(Option<DateTime>)
:Response element for GetCase that provides the actual incident start date as identified by data analysis during the investigation.
impacted_aws_regions(Option<Vec::<ImpactedAwsRegion>>)
:Response element for GetCase that provides the impacted regions.
threat_actor_ip_addresses(Option<Vec::<ThreatActorIp>>)
:Response element for GetCase that provides a list of suspicious IP addresses associated with unauthorized activity.
pending_action(Option<PendingAction>)
:Response element for GetCase that provides identifies the case is waiting on customer input.
impacted_accounts(Option<Vec::<String>>)
:Response element for GetCase that provides a list of impacted accounts.
watchers(Option<Vec::<Watcher>>)
:Response element for GetCase that provides a list of Watchers added to the case.
created_date(Option<DateTime>)
:Response element for GetCase that provides the date the case was created.
last_updated_date(Option<DateTime>)
:Response element for GetCase that provides the date a case was last modified.
closure_code(Option<ClosureCode>)
:Response element for GetCase that provides the summary code for why a case was closed.
resolver_type(Option<ResolverType>)
:Response element for GetCase that provides the current resolver types. Options include
self-supported | AWS-supported
.impacted_services(Option<Vec::<String>>)
:Response element for GetCase that provides a list of impacted services.
case_attachments(Option<Vec::<CaseAttachmentAttributes>>)
:Response element for GetCase that provides a list of current case attachments.
closed_date(Option<DateTime>)
:Response element for GetCase that provides the date a specified case was closed.
- On failure, responds with
SdkError<GetCaseError>
Source§impl Client
impl Client
Sourcepub fn get_case_attachment_download_url(
&self,
) -> GetCaseAttachmentDownloadUrlFluentBuilder
pub fn get_case_attachment_download_url( &self, ) -> GetCaseAttachmentDownloadUrlFluentBuilder
Constructs a fluent builder for the GetCaseAttachmentDownloadUrl
operation.
- The fluent builder is configurable:
case_id(impl Into<String>)
/set_case_id(Option<String>)
:
required: trueRequired element for GetCaseAttachmentDownloadUrl to identify the case ID for downloading an attachment from.
attachment_id(impl Into<String>)
/set_attachment_id(Option<String>)
:
required: trueRequired element for GetCaseAttachmentDownloadUrl to identify the attachment ID for downloading an attachment.
- On success, responds with
GetCaseAttachmentDownloadUrlOutput
with field(s):attachment_presigned_url(String)
:Response element providing the Amazon S3 presigned URL to download an attachment.
- On failure, responds with
SdkError<GetCaseAttachmentDownloadUrlError>
Source§impl Client
impl Client
Sourcepub fn get_case_attachment_upload_url(
&self,
) -> GetCaseAttachmentUploadUrlFluentBuilder
pub fn get_case_attachment_upload_url( &self, ) -> GetCaseAttachmentUploadUrlFluentBuilder
Constructs a fluent builder for the GetCaseAttachmentUploadUrl
operation.
- The fluent builder is configurable:
case_id(impl Into<String>)
/set_case_id(Option<String>)
:
required: trueRequired element for GetCaseAttachmentUploadUrl to identify the case ID for uploading an attachment to.
file_name(impl Into<String>)
/set_file_name(Option<String>)
:
required: trueRequired element for GetCaseAttachmentUploadUrl to identify the file name of the attachment to upload.
content_length(i64)
/set_content_length(Option<i64>)
:
required: trueRequired element for GetCaseAttachmentUploadUrl to identify the size od the file attachment.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseOptional element for customer provided token.
- On success, responds with
GetCaseAttachmentUploadUrlOutput
with field(s):attachment_presigned_url(String)
:Response element providing the Amazon S3 presigned UTL to upload the attachment.
- On failure, responds with
SdkError<GetCaseAttachmentUploadUrlError>
Source§impl Client
impl Client
Sourcepub fn get_membership(&self) -> GetMembershipFluentBuilder
pub fn get_membership(&self) -> GetMembershipFluentBuilder
Constructs a fluent builder for the GetMembership
operation.
- The fluent builder is configurable:
membership_id(impl Into<String>)
/set_membership_id(Option<String>)
:
required: trueRequired element for GetMembership to identify the membership ID to query.
- On success, responds with
GetMembershipOutput
with field(s):membership_id(String)
:Response element for GetMembership that provides the queried membership ID.
account_id(Option<String>)
:Response element for GetMembership that provides the configured account for managing the membership.
region(Option<AwsRegion>)
:Response element for GetMembership that provides the configured region for managing the membership.
membership_name(Option<String>)
:Response element for GetMembership that provides the configured membership name.
membership_arn(Option<String>)
:Response element for GetMembership that provides the membership ARN.
membership_status(Option<MembershipStatus>)
:Response element for GetMembership that provides the current membership status.
membership_activation_timestamp(Option<DateTime>)
:Response element for GetMembership that provides the configured membership activation timestamp.
membership_deactivation_timestamp(Option<DateTime>)
:Response element for GetMembership that provides the configured membership name deactivation timestamp.
customer_type(Option<CustomerType>)
:Response element for GetMembership that provides the configured membership type. Options include
Standalone | Organizations
.number_of_accounts_covered(Option<i64>)
:Response element for GetMembership that provides the number of accounts in the membership.
incident_response_team(Option<Vec::<IncidentResponder>>)
:Response element for GetMembership that provides the configured membership incident response team members.
opt_in_features(Option<Vec::<OptInFeature>>)
:Response element for GetMembership that provides the if opt-in features have been enabled.
- On failure, responds with
SdkError<GetMembershipError>
Source§impl Client
impl Client
Sourcepub fn list_case_edits(&self) -> ListCaseEditsFluentBuilder
pub fn list_case_edits(&self) -> ListCaseEditsFluentBuilder
Constructs a fluent builder for the ListCaseEdits
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseOptional element for a customer provided token.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseOptional element to identify how many results to obtain. There is a maximum value of 25.
case_id(impl Into<String>)
/set_case_id(Option<String>)
:
required: trueRequired element used with ListCaseEdits to identify the case to query.
- On success, responds with
ListCaseEditsOutput
with field(s):next_token(Option<String>)
:Optional element.
items(Option<Vec::<CaseEditItem>>)
:Response element for ListCaseEdits that includes the action, eventtimestamp, message, and principal for the response.
total(Option<i32>)
:Response element for ListCaseEdits that identifies the total number of edits.
- On failure, responds with
SdkError<ListCaseEditsError>
Source§impl Client
impl Client
Sourcepub fn list_cases(&self) -> ListCasesFluentBuilder
pub fn list_cases(&self) -> ListCasesFluentBuilder
Constructs a fluent builder for the ListCases
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseOptional element.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseOptional element for ListCases to limit the number of responses.
- On success, responds with
ListCasesOutput
with field(s):next_token(Option<String>)
:Optional element.
items(Option<Vec::<ListCasesItem>>)
:Response element for ListCases that includes caseARN, caseID, caseStatus, closedDate, createdDate, engagementType, lastUpdatedDate, pendingAction, resolverType, and title for each response.
total(Option<i64>)
:Response element for ListCases providing the total number of responses.
- On failure, responds with
SdkError<ListCasesError>
Source§impl Client
impl Client
Sourcepub fn list_comments(&self) -> ListCommentsFluentBuilder
pub fn list_comments(&self) -> ListCommentsFluentBuilder
Constructs a fluent builder for the ListComments
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseOptional element.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseOptional element for ListComments to limit the number of responses.
case_id(impl Into<String>)
/set_case_id(Option<String>)
:
required: trueRequired element for ListComments to designate the case to query.
- On success, responds with
ListCommentsOutput
with field(s):next_token(Option<String>)
:Optional request elements.
items(Option<Vec::<ListCommentsItem>>)
:Response element for ListComments providing the body, commentID, createDate, creator, lastUpdatedBy and lastUpdatedDate for each response.
total(Option<i32>)
:Response element for ListComments identifying the number of responses.
- On failure, responds with
SdkError<ListCommentsError>
Source§impl Client
impl Client
Sourcepub fn list_memberships(&self) -> ListMembershipsFluentBuilder
pub fn list_memberships(&self) -> ListMembershipsFluentBuilder
Constructs a fluent builder for the ListMemberships
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseOptional element.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseRequest element for ListMemberships to limit the number of responses.
- On success, responds with
ListMembershipsOutput
with field(s):next_token(Option<String>)
:Optional element.
items(Option<Vec::<ListMembershipItem>>)
:Request element for ListMemberships including the accountID, membershipARN, membershipID, membershipStatus, and region for each response.
- On failure, responds with
SdkError<ListMembershipsError>
Source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueRequired element for ListTagsForResource to provide the ARN to identify a specific resource.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(HashMap::<String, String>)
:Response element for ListTagsForResource providing content for each configured tag.
- On failure, responds with
SdkError<ListTagsForResourceError>
Source§impl Client
impl Client
Sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
pub fn tag_resource(&self) -> TagResourceFluentBuilder
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueRequired element for TagResource to identify the ARN for the resource to add a tag to.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: trueRequired element for ListTagsForResource to provide the content for a tag.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
Source§impl Client
impl Client
Sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
pub fn untag_resource(&self) -> UntagResourceFluentBuilder
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueRequired element for UnTagResource to identify the ARN for the resource to remove a tag from.
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueRequired element for UnTagResource to identify tag to remove.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
Source§impl Client
impl Client
Sourcepub fn update_case(&self) -> UpdateCaseFluentBuilder
pub fn update_case(&self) -> UpdateCaseFluentBuilder
Constructs a fluent builder for the UpdateCase
operation.
- The fluent builder is configurable:
case_id(impl Into<String>)
/set_case_id(Option<String>)
:
required: trueRequired element for UpdateCase to identify the case ID for updates.
title(impl Into<String>)
/set_title(Option<String>)
:
required: falseOptional element for UpdateCase to provide content for the title field.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseOptional element for UpdateCase to provide content for the description field.
reported_incident_start_date(DateTime)
/set_reported_incident_start_date(Option<DateTime>)
:
required: falseOptional element for UpdateCase to provide content for the customer reported incident start date field.
actual_incident_start_date(DateTime)
/set_actual_incident_start_date(Option<DateTime>)
:
required: falseOptional element for UpdateCase to provide content for the incident start date field.
engagement_type(EngagementType)
/set_engagement_type(Option<EngagementType>)
:
required: falseOptional element for UpdateCase to provide content for the engagement type field.
Available engagement types include Security Incident | Investigation
.watchers_to_add(Watcher)
/set_watchers_to_add(Option<Vec::<Watcher>>)
:
required: falseOptional element for UpdateCase to provide content to add additional watchers to a case.
watchers_to_delete(Watcher)
/set_watchers_to_delete(Option<Vec::<Watcher>>)
:
required: falseOptional element for UpdateCase to provide content to remove existing watchers from a case.
threat_actor_ip_addresses_to_add(ThreatActorIp)
/set_threat_actor_ip_addresses_to_add(Option<Vec::<ThreatActorIp>>)
:
required: falseOptional element for UpdateCase to provide content to add additional suspicious IP addresses related to a case.
threat_actor_ip_addresses_to_delete(ThreatActorIp)
/set_threat_actor_ip_addresses_to_delete(Option<Vec::<ThreatActorIp>>)
:
required: falseOptional element for UpdateCase to provide content to remove suspicious IP addresses from a case.
impacted_services_to_add(impl Into<String>)
/set_impacted_services_to_add(Option<Vec::<String>>)
:
required: falseOptional element for UpdateCase to provide content to add services impacted.
impacted_services_to_delete(impl Into<String>)
/set_impacted_services_to_delete(Option<Vec::<String>>)
:
required: falseOptional element for UpdateCase to provide content to remove services impacted.
impacted_aws_regions_to_add(ImpactedAwsRegion)
/set_impacted_aws_regions_to_add(Option<Vec::<ImpactedAwsRegion>>)
:
required: falseOptional element for UpdateCase to provide content to add regions impacted.
impacted_aws_regions_to_delete(ImpactedAwsRegion)
/set_impacted_aws_regions_to_delete(Option<Vec::<ImpactedAwsRegion>>)
:
required: falseOptional element for UpdateCase to provide content to remove regions impacted.
impacted_accounts_to_add(impl Into<String>)
/set_impacted_accounts_to_add(Option<Vec::<String>>)
:
required: falseOptional element for UpdateCase to provide content to add accounts impacted.
impacted_accounts_to_delete(impl Into<String>)
/set_impacted_accounts_to_delete(Option<Vec::<String>>)
:
required: falseOptional element for UpdateCase to provide content to add accounts impacted.
- On success, responds with
UpdateCaseOutput
- On failure, responds with
SdkError<UpdateCaseError>
Source§impl Client
impl Client
Sourcepub fn update_case_comment(&self) -> UpdateCaseCommentFluentBuilder
pub fn update_case_comment(&self) -> UpdateCaseCommentFluentBuilder
Constructs a fluent builder for the UpdateCaseComment
operation.
- The fluent builder is configurable:
case_id(impl Into<String>)
/set_case_id(Option<String>)
:
required: trueRequired element for UpdateCaseComment to identify the case ID containing the comment to be updated.
comment_id(impl Into<String>)
/set_comment_id(Option<String>)
:
required: trueRequired element for UpdateCaseComment to identify the case ID to be updated.
body(impl Into<String>)
/set_body(Option<String>)
:
required: trueRequired element for UpdateCaseComment to identify the content for the comment to be updated.
- On success, responds with
UpdateCaseCommentOutput
with field(s):comment_id(String)
:Response element for UpdateCaseComment providing the updated comment ID.
body(Option<String>)
:Response element for UpdateCaseComment providing the updated comment content.
- On failure, responds with
SdkError<UpdateCaseCommentError>
Source§impl Client
impl Client
Sourcepub fn update_case_status(&self) -> UpdateCaseStatusFluentBuilder
pub fn update_case_status(&self) -> UpdateCaseStatusFluentBuilder
Constructs a fluent builder for the UpdateCaseStatus
operation.
- The fluent builder is configurable:
case_id(impl Into<String>)
/set_case_id(Option<String>)
:
required: trueRequired element for UpdateCaseStatus to identify the case to update.
case_status(SelfManagedCaseStatus)
/set_case_status(Option<SelfManagedCaseStatus>)
:
required: trueRequired element for UpdateCaseStatus to identify the status for a case. Options include
Submitted | Detection and Analysis | Containment, Eradication and Recovery | Post-incident Activities
.
- On success, responds with
UpdateCaseStatusOutput
with field(s):case_status(Option<SelfManagedCaseStatus>)
:Response element for UpdateCaseStatus showing the newly configured status.
- On failure, responds with
SdkError<UpdateCaseStatusError>
Source§impl Client
impl Client
Sourcepub fn update_membership(&self) -> UpdateMembershipFluentBuilder
pub fn update_membership(&self) -> UpdateMembershipFluentBuilder
Constructs a fluent builder for the UpdateMembership
operation.
- The fluent builder is configurable:
membership_id(impl Into<String>)
/set_membership_id(Option<String>)
:
required: trueRequired element for UpdateMembership to identify the membership to update.
membership_name(impl Into<String>)
/set_membership_name(Option<String>)
:
required: falseOptional element for UpdateMembership to update the membership name.
incident_response_team(IncidentResponder)
/set_incident_response_team(Option<Vec::<IncidentResponder>>)
:
required: falseOptional element for UpdateMembership to update the membership name.
opt_in_features(OptInFeature)
/set_opt_in_features(Option<Vec::<OptInFeature>>)
:
required: falseOptional element for UpdateMembership to enable or disable opt-in features for the service.
- On success, responds with
UpdateMembershipOutput
- On failure, responds with
SdkError<UpdateMembershipError>
Source§impl Client
impl Client
Sourcepub fn update_resolver_type(&self) -> UpdateResolverTypeFluentBuilder
pub fn update_resolver_type(&self) -> UpdateResolverTypeFluentBuilder
Constructs a fluent builder for the UpdateResolverType
operation.
- The fluent builder is configurable:
case_id(impl Into<String>)
/set_case_id(Option<String>)
:
required: trueRequired element for UpdateResolverType to identify the case to update.
resolver_type(ResolverType)
/set_resolver_type(Option<ResolverType>)
:
required: trueRequired element for UpdateResolverType to identify the new resolver.
- On success, responds with
UpdateResolverTypeOutput
with field(s):case_id(String)
:Response element for UpdateResolver identifying the case ID being updated.
case_status(Option<CaseStatus>)
:Response element for UpdateResolver identifying the current status of the case.
resolver_type(Option<ResolverType>)
:Response element for UpdateResolver identifying the current resolver of the case.
- On failure, responds with
SdkError<UpdateResolverTypeError>
Source§impl Client
impl Client
Sourcepub fn from_conf(conf: Config) -> Self
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
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
Source§impl Client
impl Client
Sourcepub fn new(sdk_config: &SdkConfig) -> Self
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 thesleep_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 thehttp_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, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
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();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
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();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
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();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
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();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
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);