pub struct Client { /* private fields */ }
Expand description
Client for AWSServerlessApplicationRepository
Client for invoking operations on AWSServerlessApplicationRepository. Each operation on AWSServerlessApplicationRepository 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_serverlessapplicationrepository::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_serverlessapplicationrepository::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 CreateApplication
operation has
a Client::create_application
, 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_application()
.author("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 create_application(&self) -> CreateApplicationFluentBuilder
pub fn create_application(&self) -> CreateApplicationFluentBuilder
Constructs a fluent builder for the CreateApplication
operation.
- The fluent builder is configurable:
author(impl Into<String>)
/set_author(Option<String>)
:
required: trueThe name of the author publishing the app.
Minimum length=1. Maximum length=127.
Pattern “^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$”;
description(impl Into<String>)
/set_description(Option<String>)
:
required: trueThe description of the application.
Minimum length=1. Maximum length=256
home_page_url(impl Into<String>)
/set_home_page_url(Option<String>)
:
required: falseA URL with more information about the application, for example the location of your GitHub repository for the application.
labels(impl Into<String>)
/set_labels(Option<Vec::<String>>)
:
required: falseLabels to improve discovery of apps in search results.
Minimum length=1. Maximum length=127. Maximum number of labels: 10
Pattern: “^[a-zA-Z0-9+\-_:\/@]+$”;
license_body(impl Into<String>)
/set_license_body(Option<String>)
:
required: falseA local text file that contains the license of the app that matches the spdxLicenseID value of your application. The file has the format file://<path>/<filename>.
Maximum size 5 MB
You can specify only one of licenseBody and licenseUrl; otherwise, an error results.
license_url(impl Into<String>)
/set_license_url(Option<String>)
:
required: falseA link to the S3 object that contains the license of the app that matches the spdxLicenseID value of your application.
Maximum size 5 MB
You can specify only one of licenseBody and licenseUrl; otherwise, an error results.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the application that you want to publish.
Minimum length=1. Maximum length=140
Pattern: “[a-zA-Z0-9\-]+”;
readme_body(impl Into<String>)
/set_readme_body(Option<String>)
:
required: falseA local text readme file in Markdown language that contains a more detailed description of the application and how it works. The file has the format file://<path>/<filename>.
Maximum size 5 MB
You can specify only one of readmeBody and readmeUrl; otherwise, an error results.
readme_url(impl Into<String>)
/set_readme_url(Option<String>)
:
required: falseA link to the S3 object in Markdown language that contains a more detailed description of the application and how it works.
Maximum size 5 MB
You can specify only one of readmeBody and readmeUrl; otherwise, an error results.
semantic_version(impl Into<String>)
/set_semantic_version(Option<String>)
:
required: falseThe semantic version of the application:
source_code_archive_url(impl Into<String>)
/set_source_code_archive_url(Option<String>)
:
required: falseA link to the S3 object that contains the ZIP archive of the source code for this version of your application.
Maximum size 50 MB
source_code_url(impl Into<String>)
/set_source_code_url(Option<String>)
:
required: falseA link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.
spdx_license_id(impl Into<String>)
/set_spdx_license_id(Option<String>)
:
required: falseA valid identifier from https://spdx.org/licenses/.
template_body(impl Into<String>)
/set_template_body(Option<String>)
:
required: falseThe local raw packaged AWS SAM template file of your application. The file has the format file://<path>/<filename>.
You can specify only one of templateBody and templateUrl; otherwise an error results.
template_url(impl Into<String>)
/set_template_url(Option<String>)
:
required: falseA link to the S3 object containing the packaged AWS SAM template of your application.
You can specify only one of templateBody and templateUrl; otherwise an error results.
- On success, responds with
CreateApplicationOutput
with field(s):application_id(Option<String>)
:The application Amazon Resource Name (ARN).
author(Option<String>)
:The name of the author publishing the app.
Minimum length=1. Maximum length=127.
Pattern “^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$”;
creation_time(Option<String>)
:The date and time this resource was created.
description(Option<String>)
:The description of the application.
Minimum length=1. Maximum length=256
home_page_url(Option<String>)
:A URL with more information about the application, for example the location of your GitHub repository for the application.
is_verified_author(Option<bool>)
:Whether the author of this application has been verified. This means means that AWS has made a good faith review, as a reasonable and prudent service provider, of the information provided by the requester and has confirmed that the requester’s identity is as claimed.
labels(Option<Vec::<String>>)
:Labels to improve discovery of apps in search results.
Minimum length=1. Maximum length=127. Maximum number of labels: 10
Pattern: “^[a-zA-Z0-9+\-_:\/@]+$”;
license_url(Option<String>)
:A link to a license file of the app that matches the spdxLicenseID value of your application.
Maximum size 5 MB
name(Option<String>)
:The name of the application.
Minimum length=1. Maximum length=140
Pattern: “[a-zA-Z0-9\-]+”;
readme_url(Option<String>)
:A link to the readme file in Markdown language that contains a more detailed description of the application and how it works.
Maximum size 5 MB
spdx_license_id(Option<String>)
:A valid identifier from https://spdx.org/licenses/.
verified_author_url(Option<String>)
:The URL to the public profile of a verified author. This URL is submitted by the author.
version(Option<Version>)
:Version information about the application.
- On failure, responds with
SdkError<CreateApplicationError>
Source§impl Client
impl Client
Sourcepub fn create_application_version(
&self,
) -> CreateApplicationVersionFluentBuilder
pub fn create_application_version( &self, ) -> CreateApplicationVersionFluentBuilder
Constructs a fluent builder for the CreateApplicationVersion
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the application.
semantic_version(impl Into<String>)
/set_semantic_version(Option<String>)
:
required: trueThe semantic version of the new version.
source_code_archive_url(impl Into<String>)
/set_source_code_archive_url(Option<String>)
:
required: falseA link to the S3 object that contains the ZIP archive of the source code for this version of your application.
Maximum size 50 MB
source_code_url(impl Into<String>)
/set_source_code_url(Option<String>)
:
required: falseA link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.
template_body(impl Into<String>)
/set_template_body(Option<String>)
:
required: falseThe raw packaged AWS SAM template of your application.
template_url(impl Into<String>)
/set_template_url(Option<String>)
:
required: falseA link to the packaged AWS SAM template of your application.
- On success, responds with
CreateApplicationVersionOutput
with field(s):application_id(Option<String>)
:The application Amazon Resource Name (ARN).
creation_time(Option<String>)
:The date and time this resource was created.
parameter_definitions(Option<Vec::<ParameterDefinition>>)
:An array of parameter types supported by the application.
required_capabilities(Option<Vec::<Capability>>)
:A list of values that you must specify before you can deploy certain applications. Some applications might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those applications, you must explicitly acknowledge their capabilities by specifying this parameter.
The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_RESOURCE_POLICY, and CAPABILITY_AUTO_EXPAND.
The following resources require you to specify CAPABILITY_IAM or CAPABILITY_NAMED_IAM: AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, and AWS::IAM::Role. If the application contains IAM resources, you can specify either CAPABILITY_IAM or CAPABILITY_NAMED_IAM. If the application contains IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
The following resources require you to specify CAPABILITY_RESOURCE_POLICY: AWS::Lambda::Permission, AWS::IAM:Policy, AWS::ApplicationAutoScaling::ScalingPolicy, AWS::S3::BucketPolicy, AWS::SQS::QueuePolicy, and AWS::SNS::TopicPolicy.
Applications that contain one or more nested applications require you to specify CAPABILITY_AUTO_EXPAND.
If your application template contains any of the above resources, we recommend that you review all permissions associated with the application before deploying. If you don’t specify this parameter for an application that requires capabilities, the call will fail.
resources_supported(Option<bool>)
:Whether all of the AWS resources contained in this application are supported in the region in which it is being retrieved.
semantic_version(Option<String>)
:The semantic version of the application:
source_code_archive_url(Option<String>)
:A link to the S3 object that contains the ZIP archive of the source code for this version of your application.
Maximum size 50 MB
source_code_url(Option<String>)
:A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.
template_url(Option<String>)
:A link to the packaged AWS SAM template of your application.
- On failure, responds with
SdkError<CreateApplicationVersionError>
Source§impl Client
impl Client
Sourcepub fn create_cloud_formation_change_set(
&self,
) -> CreateCloudFormationChangeSetFluentBuilder
pub fn create_cloud_formation_change_set( &self, ) -> CreateCloudFormationChangeSetFluentBuilder
Constructs a fluent builder for the CreateCloudFormationChangeSet
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the application.
capabilities(impl Into<String>)
/set_capabilities(Option<Vec::<String>>)
:
required: falseA list of values that you must specify before you can deploy certain applications. Some applications might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those applications, you must explicitly acknowledge their capabilities by specifying this parameter.
The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_RESOURCE_POLICY, and CAPABILITY_AUTO_EXPAND.
The following resources require you to specify CAPABILITY_IAM or CAPABILITY_NAMED_IAM: AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, and AWS::IAM::Role. If the application contains IAM resources, you can specify either CAPABILITY_IAM or CAPABILITY_NAMED_IAM. If the application contains IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
The following resources require you to specify CAPABILITY_RESOURCE_POLICY: AWS::Lambda::Permission, AWS::IAM:Policy, AWS::ApplicationAutoScaling::ScalingPolicy, AWS::S3::BucketPolicy, AWS::SQS::QueuePolicy, and AWS::SNS:TopicPolicy.
Applications that contain one or more nested applications require you to specify CAPABILITY_AUTO_EXPAND.
If your application template contains any of the above resources, we recommend that you review all permissions associated with the application before deploying. If you don’t specify this parameter for an application that requires capabilities, the call will fail.
change_set_name(impl Into<String>)
/set_change_set_name(Option<String>)
:
required: falseThis property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseThis property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThis property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
notification_arns(impl Into<String>)
/set_notification_arns(Option<Vec::<String>>)
:
required: falseThis property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
parameter_overrides(ParameterValue)
/set_parameter_overrides(Option<Vec::<ParameterValue>>)
:
required: falseA list of parameter values for the parameters of the application.
resource_types(impl Into<String>)
/set_resource_types(Option<Vec::<String>>)
:
required: falseThis property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
rollback_configuration(RollbackConfiguration)
/set_rollback_configuration(Option<RollbackConfiguration>)
:
required: falseThis property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
semantic_version(impl Into<String>)
/set_semantic_version(Option<String>)
:
required: falseThe semantic version of the application:
stack_name(impl Into<String>)
/set_stack_name(Option<String>)
:
required: trueThis property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseThis property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.
template_id(impl Into<String>)
/set_template_id(Option<String>)
:
required: falseThe UUID returned by CreateCloudFormationTemplate.
Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}
- On success, responds with
CreateCloudFormationChangeSetOutput
with field(s):application_id(Option<String>)
:The application Amazon Resource Name (ARN).
change_set_id(Option<String>)
:The Amazon Resource Name (ARN) of the change set.
Length constraints: Minimum length of 1.
Pattern: ARN:[-a-zA-Z0-9:/]*
semantic_version(Option<String>)
:The semantic version of the application:
stack_id(Option<String>)
:The unique ID of the stack.
- On failure, responds with
SdkError<CreateCloudFormationChangeSetError>
Source§impl Client
impl Client
Sourcepub fn create_cloud_formation_template(
&self,
) -> CreateCloudFormationTemplateFluentBuilder
pub fn create_cloud_formation_template( &self, ) -> CreateCloudFormationTemplateFluentBuilder
Constructs a fluent builder for the CreateCloudFormationTemplate
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the application.
semantic_version(impl Into<String>)
/set_semantic_version(Option<String>)
:
required: falseThe semantic version of the application:
- On success, responds with
CreateCloudFormationTemplateOutput
with field(s):application_id(Option<String>)
:The application Amazon Resource Name (ARN).
creation_time(Option<String>)
:The date and time this resource was created.
expiration_time(Option<String>)
:The date and time this template expires. Templates expire 1 hour after creation.
semantic_version(Option<String>)
:The semantic version of the application:
status(Option<Status>)
:Status of the template creation workflow.
Possible values: PREPARING | ACTIVE | EXPIRED
template_id(Option<String>)
:The UUID returned by CreateCloudFormationTemplate.
Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}
template_url(Option<String>)
:A link to the template that can be used to deploy the application using AWS CloudFormation.
- On failure, responds with
SdkError<CreateCloudFormationTemplateError>
Source§impl Client
impl Client
Sourcepub fn delete_application(&self) -> DeleteApplicationFluentBuilder
pub fn delete_application(&self) -> DeleteApplicationFluentBuilder
Constructs a fluent builder for the DeleteApplication
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the application.
- On success, responds with
DeleteApplicationOutput
- On failure, responds with
SdkError<DeleteApplicationError>
Source§impl Client
impl Client
Sourcepub fn get_application(&self) -> GetApplicationFluentBuilder
pub fn get_application(&self) -> GetApplicationFluentBuilder
Constructs a fluent builder for the GetApplication
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the application.
semantic_version(impl Into<String>)
/set_semantic_version(Option<String>)
:
required: falseThe semantic version of the application to get.
- On success, responds with
GetApplicationOutput
with field(s):application_id(Option<String>)
:The application Amazon Resource Name (ARN).
author(Option<String>)
:The name of the author publishing the app.
Minimum length=1. Maximum length=127.
Pattern “^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$”;
creation_time(Option<String>)
:The date and time this resource was created.
description(Option<String>)
:The description of the application.
Minimum length=1. Maximum length=256
home_page_url(Option<String>)
:A URL with more information about the application, for example the location of your GitHub repository for the application.
is_verified_author(Option<bool>)
:Whether the author of this application has been verified. This means means that AWS has made a good faith review, as a reasonable and prudent service provider, of the information provided by the requester and has confirmed that the requester’s identity is as claimed.
labels(Option<Vec::<String>>)
:Labels to improve discovery of apps in search results.
Minimum length=1. Maximum length=127. Maximum number of labels: 10
Pattern: “^[a-zA-Z0-9+\-_:\/@]+$”;
license_url(Option<String>)
:A link to a license file of the app that matches the spdxLicenseID value of your application.
Maximum size 5 MB
name(Option<String>)
:The name of the application.
Minimum length=1. Maximum length=140
Pattern: “[a-zA-Z0-9\-]+”;
readme_url(Option<String>)
:A link to the readme file in Markdown language that contains a more detailed description of the application and how it works.
Maximum size 5 MB
spdx_license_id(Option<String>)
:A valid identifier from https://spdx.org/licenses/.
verified_author_url(Option<String>)
:The URL to the public profile of a verified author. This URL is submitted by the author.
version(Option<Version>)
:Version information about the application.
- On failure, responds with
SdkError<GetApplicationError>
Source§impl Client
impl Client
Sourcepub fn get_application_policy(&self) -> GetApplicationPolicyFluentBuilder
pub fn get_application_policy(&self) -> GetApplicationPolicyFluentBuilder
Constructs a fluent builder for the GetApplicationPolicy
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the application.
- On success, responds with
GetApplicationPolicyOutput
with field(s):statements(Option<Vec::<ApplicationPolicyStatement>>)
:An array of policy statements applied to the application.
- On failure, responds with
SdkError<GetApplicationPolicyError>
Source§impl Client
impl Client
Sourcepub fn get_cloud_formation_template(
&self,
) -> GetCloudFormationTemplateFluentBuilder
pub fn get_cloud_formation_template( &self, ) -> GetCloudFormationTemplateFluentBuilder
Constructs a fluent builder for the GetCloudFormationTemplate
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the application.
template_id(impl Into<String>)
/set_template_id(Option<String>)
:
required: trueThe UUID returned by CreateCloudFormationTemplate.
Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}
- On success, responds with
GetCloudFormationTemplateOutput
with field(s):application_id(Option<String>)
:The application Amazon Resource Name (ARN).
creation_time(Option<String>)
:The date and time this resource was created.
expiration_time(Option<String>)
:The date and time this template expires. Templates expire 1 hour after creation.
semantic_version(Option<String>)
:The semantic version of the application:
status(Option<Status>)
:Status of the template creation workflow.
Possible values: PREPARING | ACTIVE | EXPIRED
template_id(Option<String>)
:The UUID returned by CreateCloudFormationTemplate.
Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}
template_url(Option<String>)
:A link to the template that can be used to deploy the application using AWS CloudFormation.
- On failure, responds with
SdkError<GetCloudFormationTemplateError>
Source§impl Client
impl Client
Sourcepub fn list_application_dependencies(
&self,
) -> ListApplicationDependenciesFluentBuilder
pub fn list_application_dependencies( &self, ) -> ListApplicationDependenciesFluentBuilder
Constructs a fluent builder for the ListApplicationDependencies
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the application.
max_items(i32)
/set_max_items(Option<i32>)
:
required: falseThe total number of items to return.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA token to specify where to start paginating.
semantic_version(impl Into<String>)
/set_semantic_version(Option<String>)
:
required: falseThe semantic version of the application to get.
- On success, responds with
ListApplicationDependenciesOutput
with field(s):dependencies(Option<Vec::<ApplicationDependencySummary>>)
:An array of application summaries nested in the application.
next_token(Option<String>)
:The token to request the next page of results.
- On failure, responds with
SdkError<ListApplicationDependenciesError>
Source§impl Client
impl Client
Sourcepub fn list_application_versions(&self) -> ListApplicationVersionsFluentBuilder
pub fn list_application_versions(&self) -> ListApplicationVersionsFluentBuilder
Constructs a fluent builder for the ListApplicationVersions
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the application.
max_items(i32)
/set_max_items(Option<i32>)
:
required: falseThe total number of items to return.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA token to specify where to start paginating.
- On success, responds with
ListApplicationVersionsOutput
with field(s):next_token(Option<String>)
:The token to request the next page of results.
versions(Option<Vec::<VersionSummary>>)
:An array of version summaries for the application.
- On failure, responds with
SdkError<ListApplicationVersionsError>
Source§impl Client
impl Client
Sourcepub fn list_applications(&self) -> ListApplicationsFluentBuilder
pub fn list_applications(&self) -> ListApplicationsFluentBuilder
Constructs a fluent builder for the ListApplications
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_items(i32)
/set_max_items(Option<i32>)
:
required: falseThe total number of items to return.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA token to specify where to start paginating.
- On success, responds with
ListApplicationsOutput
with field(s):applications(Option<Vec::<ApplicationSummary>>)
:An array of application summaries.
next_token(Option<String>)
:The token to request the next page of results.
- On failure, responds with
SdkError<ListApplicationsError>
Source§impl Client
impl Client
Sourcepub fn put_application_policy(&self) -> PutApplicationPolicyFluentBuilder
pub fn put_application_policy(&self) -> PutApplicationPolicyFluentBuilder
Constructs a fluent builder for the PutApplicationPolicy
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the application.
statements(ApplicationPolicyStatement)
/set_statements(Option<Vec::<ApplicationPolicyStatement>>)
:
required: trueAn array of policy statements applied to the application.
- On success, responds with
PutApplicationPolicyOutput
with field(s):statements(Option<Vec::<ApplicationPolicyStatement>>)
:An array of policy statements applied to the application.
- On failure, responds with
SdkError<PutApplicationPolicyError>
Source§impl Client
impl Client
Constructs a fluent builder for the UnshareApplication
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the application.
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:
required: trueThe AWS Organization ID to unshare the application from.
- On success, responds with
UnshareApplicationOutput
- On failure, responds with
SdkError<UnshareApplicationError>
Source§impl Client
impl Client
Sourcepub fn update_application(&self) -> UpdateApplicationFluentBuilder
pub fn update_application(&self) -> UpdateApplicationFluentBuilder
Constructs a fluent builder for the UpdateApplication
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the application.
author(impl Into<String>)
/set_author(Option<String>)
:
required: falseThe name of the author publishing the app.
Minimum length=1. Maximum length=127.
Pattern “^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$”;
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the application.
Minimum length=1. Maximum length=256
home_page_url(impl Into<String>)
/set_home_page_url(Option<String>)
:
required: falseA URL with more information about the application, for example the location of your GitHub repository for the application.
labels(impl Into<String>)
/set_labels(Option<Vec::<String>>)
:
required: falseLabels to improve discovery of apps in search results.
Minimum length=1. Maximum length=127. Maximum number of labels: 10
Pattern: “^[a-zA-Z0-9+\-_:\/@]+$”;
readme_body(impl Into<String>)
/set_readme_body(Option<String>)
:
required: falseA text readme file in Markdown language that contains a more detailed description of the application and how it works.
Maximum size 5 MB
readme_url(impl Into<String>)
/set_readme_url(Option<String>)
:
required: falseA link to the readme file in Markdown language that contains a more detailed description of the application and how it works.
Maximum size 5 MB
- On success, responds with
UpdateApplicationOutput
with field(s):application_id(Option<String>)
:The application Amazon Resource Name (ARN).
author(Option<String>)
:The name of the author publishing the app.
Minimum length=1. Maximum length=127.
Pattern “^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$”;
creation_time(Option<String>)
:The date and time this resource was created.
description(Option<String>)
:The description of the application.
Minimum length=1. Maximum length=256
home_page_url(Option<String>)
:A URL with more information about the application, for example the location of your GitHub repository for the application.
is_verified_author(Option<bool>)
:Whether the author of this application has been verified. This means means that AWS has made a good faith review, as a reasonable and prudent service provider, of the information provided by the requester and has confirmed that the requester’s identity is as claimed.
labels(Option<Vec::<String>>)
:Labels to improve discovery of apps in search results.
Minimum length=1. Maximum length=127. Maximum number of labels: 10
Pattern: “^[a-zA-Z0-9+\-_:\/@]+$”;
license_url(Option<String>)
:A link to a license file of the app that matches the spdxLicenseID value of your application.
Maximum size 5 MB
name(Option<String>)
:The name of the application.
Minimum length=1. Maximum length=140
Pattern: “[a-zA-Z0-9\-]+”;
readme_url(Option<String>)
:A link to the readme file in Markdown language that contains a more detailed description of the application and how it works.
Maximum size 5 MB
spdx_license_id(Option<String>)
:A valid identifier from https://spdx.org/licenses/.
verified_author_url(Option<String>)
:The URL to the public profile of a verified author. This URL is submitted by the author.
version(Option<Version>)
:Version information about the application.
- On failure, responds with
SdkError<UpdateApplicationError>
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);