pub struct Client { /* private fields */ }
Expand description
Client for Amazon CodeGuru Security
Client for invoking operations on Amazon CodeGuru Security. Each operation on Amazon CodeGuru Security 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_codegurusecurity::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_codegurusecurity::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 CreateScan
operation has
a Client::create_scan
, 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.create_scan()
.client_token("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_findings(&self) -> BatchGetFindingsFluentBuilder
pub fn batch_get_findings(&self) -> BatchGetFindingsFluentBuilder
Constructs a fluent builder for the BatchGetFindings
operation.
- The fluent builder is configurable:
finding_identifiers(FindingIdentifier)
/set_finding_identifiers(Option<Vec::<FindingIdentifier>>)
:
required: trueA list of finding identifiers. Each identifier consists of a
scanName
and afindingId
. You retrieve thefindingId
when you callGetFindings
.
- On success, responds with
BatchGetFindingsOutput
with field(s):findings(Vec::<Finding>)
:A list of all findings which were successfully fetched.
failed_findings(Vec::<BatchGetFindingsError>)
:A list of errors for individual findings which were not fetched. Each BatchGetFindingsError contains the
scanName
,findingId
,errorCode
and errormessage
.
- On failure, responds with
SdkError<BatchGetFindingsError>
Source§impl Client
impl Client
Sourcepub fn create_scan(&self) -> CreateScanFluentBuilder
pub fn create_scan(&self) -> CreateScanFluentBuilder
Constructs a fluent builder for the CreateScan
operation.
- The fluent builder is configurable:
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseThe idempotency token for the request. Amazon CodeGuru Security uses this value to prevent the accidental creation of duplicate scans if there are failures and retries.
resource_id(ResourceId)
/set_resource_id(Option<ResourceId>)
:
required: trueThe identifier for the resource object to be scanned.
scan_name(impl Into<String>)
/set_scan_name(Option<String>)
:
required: trueThe unique name that CodeGuru Security uses to track revisions across multiple scans of the same resource. Only allowed for a
STANDARD
scan type.scan_type(ScanType)
/set_scan_type(Option<ScanType>)
:
required: falseThe type of scan, either
Standard
orExpress
. Defaults toStandard
type if missing.Express
scans run on limited resources and use a limited set of detectors to analyze your code in near-real time.Standard
scans have standard resource limits and use the full set of detectors to analyze your code.analysis_type(AnalysisType)
/set_analysis_type(Option<AnalysisType>)
:
required: falseThe type of analysis you want CodeGuru Security to perform in the scan, either
Security
orAll
. TheSecurity
type only generates findings related to security. TheAll
type generates both security findings and quality findings. Defaults toSecurity
type if missing.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseAn array of key-value pairs used to tag a scan. A tag is a custom attribute label with two parts:
-
A tag key. For example,
CostCenter
,Environment
, orSecret
. Tag keys are case sensitive. -
An optional tag value field. For example,
111122223333
,Production
, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.
-
- On success, responds with
CreateScanOutput
with field(s):scan_name(String)
:The name of the scan.
run_id(String)
:UUID that identifies the individual scan run.
resource_id(Option<ResourceId>)
:The identifier for the resource object that contains resources that were scanned.
scan_state(ScanState)
:The current state of the scan. Returns either
InProgress
,Successful
, orFailed
.scan_name_arn(Option<String>)
:The ARN for the scan name.
- On failure, responds with
SdkError<CreateScanError>
Source§impl Client
impl Client
Sourcepub fn create_upload_url(&self) -> CreateUploadUrlFluentBuilder
pub fn create_upload_url(&self) -> CreateUploadUrlFluentBuilder
Constructs a fluent builder for the CreateUploadUrl
operation.
- The fluent builder is configurable:
scan_name(impl Into<String>)
/set_scan_name(Option<String>)
:
required: trueThe name of the scan that will use the uploaded resource. CodeGuru Security uses the unique scan name to track revisions across multiple scans of the same resource. Use this
scanName
when you callCreateScan
on the code resource you upload to this URL.
- On success, responds with
CreateUploadUrlOutput
with field(s):s3_url(String)
:A pre-signed S3 URL. You can upload the code file you want to scan with the required
requestHeaders
using any HTTP client.request_headers(HashMap::<String, String>)
:A set of key-value pairs that contain the required headers when uploading your resource.
code_artifact_id(String)
:The identifier for the uploaded code resource. Pass this to
CreateScan
to use the uploaded resources.
- On failure, responds with
SdkError<CreateUploadUrlError>
Source§impl Client
impl Client
Sourcepub fn get_account_configuration(&self) -> GetAccountConfigurationFluentBuilder
pub fn get_account_configuration(&self) -> GetAccountConfigurationFluentBuilder
Constructs a fluent builder for the GetAccountConfiguration
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
GetAccountConfigurationOutput
with field(s):encryption_config(Option<EncryptionConfig>)
:An
EncryptionConfig
object that contains the KMS key ARN that is used for encryption. By default, CodeGuru Security uses an AWS-managed key for encryption. To specify your own key, callUpdateAccountConfiguration
. If you do not specify a customer-managed key, returns empty.
- On failure, responds with
SdkError<GetAccountConfigurationError>
Source§impl Client
impl Client
Sourcepub fn get_findings(&self) -> GetFindingsFluentBuilder
pub fn get_findings(&self) -> GetFindingsFluentBuilder
Constructs a fluent builder for the GetFindings
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
scan_name(impl Into<String>)
/set_scan_name(Option<String>)
:
required: trueThe name of the scan you want to retrieve findings from.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the
nextToken
value returned from the previous request to continue listing results after the first page.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in the response. Use this parameter when paginating results. If additional results exist beyond the number you specify, the
nextToken
element is returned in the response. UsenextToken
in a subsequent request to retrieve additional results. If not specified, returns 1000 results.status(Status)
/set_status(Option<Status>)
:
required: falseThe status of the findings you want to get. Pass either
Open
,Closed
, orAll
.
- On success, responds with
GetFindingsOutput
with field(s):findings(Option<Vec::<Finding>>)
:A list of findings generated by the specified scan.
next_token(Option<String>)
:A pagination token. You can use this in future calls to
GetFindings
to continue listing results after the current page.
- On failure, responds with
SdkError<GetFindingsError>
Source§impl Client
impl Client
Sourcepub fn get_metrics_summary(&self) -> GetMetricsSummaryFluentBuilder
pub fn get_metrics_summary(&self) -> GetMetricsSummaryFluentBuilder
Constructs a fluent builder for the GetMetricsSummary
operation.
- The fluent builder is configurable:
date(DateTime)
/set_date(Option<DateTime>)
:
required: trueThe date you want to retrieve summary metrics from, rounded to the nearest day. The date must be within the past two years.
- On success, responds with
GetMetricsSummaryOutput
with field(s):metrics_summary(Option<MetricsSummary>)
:The summary metrics from the specified date.
- On failure, responds with
SdkError<GetMetricsSummaryError>
Source§impl Client
impl Client
Sourcepub fn get_scan(&self) -> GetScanFluentBuilder
pub fn get_scan(&self) -> GetScanFluentBuilder
Constructs a fluent builder for the GetScan
operation.
- The fluent builder is configurable:
scan_name(impl Into<String>)
/set_scan_name(Option<String>)
:
required: trueThe name of the scan you want to view details about.
run_id(impl Into<String>)
/set_run_id(Option<String>)
:
required: falseUUID that identifies the individual scan run you want to view details about. You retrieve this when you call the
CreateScan
operation. Defaults to the latest scan run if missing.
- On success, responds with
GetScanOutput
with field(s):scan_name(String)
:The name of the scan.
run_id(String)
:UUID that identifies the individual scan run.
scan_state(ScanState)
:The current state of the scan. Returns either
InProgress
,Successful
, orFailed
.created_at(DateTime)
:The time the scan was created.
analysis_type(AnalysisType)
:The type of analysis CodeGuru Security performed in the scan, either
Security
orAll
. TheSecurity
type only generates findings related to security. TheAll
type generates both security findings and quality findings.updated_at(Option<DateTime>)
:The time when the scan was last updated. Only available for
STANDARD
scan types.number_of_revisions(Option<i64>)
:The number of times a scan has been re-run on a revised resource.
scan_name_arn(Option<String>)
:The ARN for the scan name.
error_message(Option<String>)
:Details about the error that causes a scan to fail to be retrieved.
- On failure, responds with
SdkError<GetScanError>
Source§impl Client
impl Client
Sourcepub fn list_findings_metrics(&self) -> ListFindingsMetricsFluentBuilder
pub fn list_findings_metrics(&self) -> ListFindingsMetricsFluentBuilder
Constructs a fluent builder for the ListFindingsMetrics
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the
nextToken
value returned from the previous request to continue listing results after the first page.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in the response. Use this parameter when paginating results. If additional results exist beyond the number you specify, the
nextToken
element is returned in the response. UsenextToken
in a subsequent request to retrieve additional results. If not specified, returns 1000 results.start_date(DateTime)
/set_start_date(Option<DateTime>)
:
required: trueThe start date of the interval which you want to retrieve metrics from. Rounds to the nearest day.
end_date(DateTime)
/set_end_date(Option<DateTime>)
:
required: trueThe end date of the interval which you want to retrieve metrics from. Round to the nearest day.
- On success, responds with
ListFindingsMetricsOutput
with field(s):findings_metrics(Option<Vec::<AccountFindingsMetric>>)
:A list of
AccountFindingsMetric
objects retrieved from the specified time interval.next_token(Option<String>)
:A pagination token. You can use this in future calls to
ListFindingMetrics
to continue listing results after the current page.
- On failure, responds with
SdkError<ListFindingsMetricsError>
Source§impl Client
impl Client
Sourcepub fn list_scans(&self) -> ListScansFluentBuilder
pub fn list_scans(&self) -> ListScansFluentBuilder
Constructs a fluent builder for the ListScans
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the
nextToken
value returned from the previous request to continue listing results after the first page.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in the response. Use this parameter when paginating results. If additional results exist beyond the number you specify, the
nextToken
element is returned in the response. UsenextToken
in a subsequent request to retrieve additional results. If not specified, returns 100 results.
- On success, responds with
ListScansOutput
with field(s):summaries(Option<Vec::<ScanSummary>>)
:A list of
ScanSummary
objects with information about all scans in an account.next_token(Option<String>)
:A pagination token. You can use this in future calls to
ListScans
to continue listing results after the current page.
- On failure, responds with
SdkError<ListScansError>
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: trueThe ARN of the
ScanName
object. You can retrieve this ARN by callingCreateScan
,ListScans
, orGetScan
.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<HashMap::<String, String>>)
:An array of key-value pairs used to tag an existing scan. A tag is a custom attribute label with two parts:
-
A tag key. For example,
CostCenter
,Environment
, orSecret
. Tag keys are case sensitive. -
An optional tag value field. For example,
111122223333
,Production
, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.
-
- 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: trueThe ARN of the
ScanName
object. You can retrieve this ARN by callingCreateScan
,ListScans
, orGetScan
.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: trueAn array of key-value pairs used to tag an existing scan. A tag is a custom attribute label with two parts:
-
A tag key. For example,
CostCenter
,Environment
, orSecret
. Tag keys are case sensitive. -
An optional tag value field. For example,
111122223333
,Production
, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.
-
- 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: trueThe ARN of the
ScanName
object. You can retrieve this ARN by callingCreateScan
,ListScans
, orGetScan
.tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueA list of keys for each tag you want to remove from a scan.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
Source§impl Client
impl Client
Sourcepub fn update_account_configuration(
&self,
) -> UpdateAccountConfigurationFluentBuilder
pub fn update_account_configuration( &self, ) -> UpdateAccountConfigurationFluentBuilder
Constructs a fluent builder for the UpdateAccountConfiguration
operation.
- The fluent builder is configurable:
encryption_config(EncryptionConfig)
/set_encryption_config(Option<EncryptionConfig>)
:
required: trueThe customer-managed KMS key ARN you want to use for encryption. If not specified, CodeGuru Security will use an AWS-managed key for encryption. If you previously specified a customer-managed KMS key and want CodeGuru Security to use an AWS-managed key for encryption instead, pass nothing.
- On success, responds with
UpdateAccountConfigurationOutput
with field(s):encryption_config(Option<EncryptionConfig>)
:An
EncryptionConfig
object that contains the KMS key ARN that is used for encryption. If you did not specify a customer-managed KMS key in the request, returns empty.
- On failure, responds with
SdkError<UpdateAccountConfigurationError>
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);