pub struct Client { /* private fields */ }
Expand description
Client for Amazon VPC Lattice
Client for invoking operations on Amazon VPC Lattice. Each operation on Amazon VPC Lattice 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_vpclattice::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_vpclattice::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 BatchUpdateRule
operation has
a Client::batch_update_rule
, 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_update_rule()
.service_identifier("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_update_rule(&self) -> BatchUpdateRuleFluentBuilder
pub fn batch_update_rule(&self) -> BatchUpdateRuleFluentBuilder
Constructs a fluent builder for the BatchUpdateRule
operation.
- The fluent builder is configurable:
service_identifier(impl Into<String>)
/set_service_identifier(Option<String>)
:
required: trueThe ID or ARN of the service.
listener_identifier(impl Into<String>)
/set_listener_identifier(Option<String>)
:
required: trueThe ID or ARN of the listener.
rules(RuleUpdate)
/set_rules(Option<Vec::<RuleUpdate>>)
:
required: trueThe rules for the specified listener.
- On success, responds with
BatchUpdateRuleOutput
with field(s):successful(Option<Vec::<RuleUpdateSuccess>>)
:The rules that were successfully updated.
unsuccessful(Option<Vec::<RuleUpdateFailure>>)
:The rules that the operation couldn’t update.
- On failure, responds with
SdkError<BatchUpdateRuleError>
Source§impl Client
impl Client
Sourcepub fn create_access_log_subscription(
&self,
) -> CreateAccessLogSubscriptionFluentBuilder
pub fn create_access_log_subscription( &self, ) -> CreateAccessLogSubscriptionFluentBuilder
Constructs a fluent builder for the CreateAccessLogSubscription
operation.
- The fluent builder is configurable:
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren’t identical, the retry fails.
resource_identifier(impl Into<String>)
/set_resource_identifier(Option<String>)
:
required: trueThe ID or ARN of the service network or service.
destination_arn(impl Into<String>)
/set_destination_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the destination. The supported destination types are CloudWatch Log groups, Kinesis Data Firehose delivery streams, and Amazon S3 buckets.
service_network_log_type(ServiceNetworkLogType)
/set_service_network_log_type(Option<ServiceNetworkLogType>)
:
required: falseThe type of log that monitors your Amazon VPC Lattice service networks.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe tags for the access log subscription.
- On success, responds with
CreateAccessLogSubscriptionOutput
with field(s):id(String)
:The ID of the access log subscription.
arn(String)
:The Amazon Resource Name (ARN) of the access log subscription.
resource_id(String)
:The ID of the service network or service.
resource_arn(String)
:The Amazon Resource Name (ARN) of the service network or service.
service_network_log_type(Option<ServiceNetworkLogType>)
:The type of log that monitors your Amazon VPC Lattice service networks.
destination_arn(String)
:The Amazon Resource Name (ARN) of the log destination.
- On failure, responds with
SdkError<CreateAccessLogSubscriptionError>
Source§impl Client
impl Client
Sourcepub fn create_listener(&self) -> CreateListenerFluentBuilder
pub fn create_listener(&self) -> CreateListenerFluentBuilder
Constructs a fluent builder for the CreateListener
operation.
- The fluent builder is configurable:
service_identifier(impl Into<String>)
/set_service_identifier(Option<String>)
:
required: trueThe ID or ARN of the service.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the listener. A listener name must be unique within a service. The valid characters are a-z, 0-9, and hyphens (-). You can’t use a hyphen as the first or last character, or immediately after another hyphen.
protocol(ListenerProtocol)
/set_protocol(Option<ListenerProtocol>)
:
required: trueThe listener protocol.
port(i32)
/set_port(Option<i32>)
:
required: falseThe listener port. You can specify a value from 1 to 65535. For HTTP, the default is 80. For HTTPS, the default is 443.
default_action(RuleAction)
/set_default_action(Option<RuleAction>)
:
required: trueThe action for the default rule. Each listener has a default rule. The default rule is used if no other rules match.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren’t identical, the retry fails.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe tags for the listener.
- On success, responds with
CreateListenerOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name (ARN) of the listener.
id(Option<String>)
:The ID of the listener.
name(Option<String>)
:The name of the listener.
protocol(Option<ListenerProtocol>)
:The protocol of the listener.
port(Option<i32>)
:The port number of the listener.
service_arn(Option<String>)
:The Amazon Resource Name (ARN) of the service.
service_id(Option<String>)
:The ID of the service.
default_action(Option<RuleAction>)
:The action for the default rule.
- On failure, responds with
SdkError<CreateListenerError>
Source§impl Client
impl Client
Sourcepub fn create_resource_configuration(
&self,
) -> CreateResourceConfigurationFluentBuilder
pub fn create_resource_configuration( &self, ) -> CreateResourceConfigurationFluentBuilder
Constructs a fluent builder for the CreateResourceConfiguration
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the resource configuration. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can’t use a hyphen as the first or last character, or immediately after another hyphen.
r#type(ResourceConfigurationType)
/set_type(Option<ResourceConfigurationType>)
:
required: trueThe type of resource configuration.
-
SINGLE
- A single resource. -
GROUP
- A group of resources. You must create a group resource configuration before you create a child resource configuration. -
CHILD
- A single resource that is part of a group resource configuration. -
ARN
- An Amazon Web Services resource.
-
port_ranges(impl Into<String>)
/set_port_ranges(Option<Vec::<String>>)
:
required: false(SINGLE, GROUP, CHILD) The TCP port ranges that a consumer can use to access a resource configuration (for example: 1-65535). You can separate port ranges using commas (for example: 1,2,22-30).
protocol(ProtocolType)
/set_protocol(Option<ProtocolType>)
:
required: false(SINGLE, GROUP) The protocol accepted by the resource configuration.
resource_gateway_identifier(impl Into<String>)
/set_resource_gateway_identifier(Option<String>)
:
required: false(SINGLE, GROUP, ARN) The ID or ARN of the resource gateway used to connect to the resource configuration. For a child resource configuration, this value is inherited from the parent resource configuration.
resource_configuration_group_identifier(impl Into<String>)
/set_resource_configuration_group_identifier(Option<String>)
:
required: false(CHILD) The ID or ARN of the parent resource configuration (type is
GROUP
). This is used to associate a child resource configuration with a group resource configuration.resource_configuration_definition(ResourceConfigurationDefinition)
/set_resource_configuration_definition(Option<ResourceConfigurationDefinition>)
:
required: false(SINGLE, CHILD, ARN) The resource configuration.
allow_association_to_shareable_service_network(bool)
/set_allow_association_to_shareable_service_network(Option<bool>)
:
required: false(SINGLE, GROUP, ARN) Specifies whether the resource configuration can be associated with a sharable service network. The default is false.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren’t identical, the retry fails.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe tags for the resource configuration.
- On success, responds with
CreateResourceConfigurationOutput
with field(s):id(Option<String>)
:The ID of the resource configuration.
name(Option<String>)
:The name of the resource configuration.
arn(Option<String>)
:The Amazon Resource Name (ARN) of the resource configuration.
resource_gateway_id(Option<String>)
:The ID of the resource gateway associated with the resource configuration.
resource_configuration_group_id(Option<String>)
:The ID of the parent resource configuration (type is GROUP).
r#type(Option<ResourceConfigurationType>)
:The type of resource configuration.
port_ranges(Option<Vec::<String>>)
:The port range.
protocol(Option<ProtocolType>)
:The protocol.
status(Option<ResourceConfigurationStatus>)
:The current status of the resource configuration.
resource_configuration_definition(Option<ResourceConfigurationDefinition>)
:The resource configuration.
allow_association_to_shareable_service_network(Option<bool>)
:Specifies whether the resource configuration can be associated with a sharable service network.
created_at(Option<DateTime>)
:The date and time that the resource configuration was created, in ISO-8601 format.
failure_reason(Option<String>)
:The reason that the request failed.
- On failure, responds with
SdkError<CreateResourceConfigurationError>
Source§impl Client
impl Client
Sourcepub fn create_resource_gateway(&self) -> CreateResourceGatewayFluentBuilder
pub fn create_resource_gateway(&self) -> CreateResourceGatewayFluentBuilder
Constructs a fluent builder for the CreateResourceGateway
operation.
- The fluent builder is configurable:
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren’t identical, the retry fails.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the resource gateway.
vpc_identifier(impl Into<String>)
/set_vpc_identifier(Option<String>)
:
required: trueThe ID of the VPC for the resource gateway.
subnet_ids(impl Into<String>)
/set_subnet_ids(Option<Vec::<String>>)
:
required: trueThe IDs of the VPC subnets in which to create the resource gateway.
security_group_ids(impl Into<String>)
/set_security_group_ids(Option<Vec::<String>>)
:
required: falseThe IDs of the security groups to apply to the resource gateway. The security groups must be in the same VPC.
ip_address_type(ResourceGatewayIpAddressType)
/set_ip_address_type(Option<ResourceGatewayIpAddressType>)
:
required: falseThe type of IP address used by the resource gateway.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe tags for the resource gateway.
- On success, responds with
CreateResourceGatewayOutput
with field(s):name(Option<String>)
:The name of the resource gateway.
id(Option<String>)
:The ID of the resource gateway.
arn(Option<String>)
:The Amazon Resource Name (ARN) of the resource gateway.
status(Option<ResourceGatewayStatus>)
:The status of the resource gateway.
vpc_identifier(Option<String>)
:The ID of the VPC.
subnet_ids(Option<Vec::<String>>)
:The IDs of the resource gateway subnets.
security_group_ids(Option<Vec::<String>>)
:The IDs of the security groups for the resource gateway.
ip_address_type(Option<ResourceGatewayIpAddressType>)
:The type of IP address for the resource gateway.
- On failure, responds with
SdkError<CreateResourceGatewayError>
Source§impl Client
impl Client
Sourcepub fn create_rule(&self) -> CreateRuleFluentBuilder
pub fn create_rule(&self) -> CreateRuleFluentBuilder
Constructs a fluent builder for the CreateRule
operation.
- The fluent builder is configurable:
service_identifier(impl Into<String>)
/set_service_identifier(Option<String>)
:
required: trueThe ID or ARN of the service.
listener_identifier(impl Into<String>)
/set_listener_identifier(Option<String>)
:
required: trueThe ID or ARN of the listener.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the rule. The name must be unique within the listener. The valid characters are a-z, 0-9, and hyphens (-). You can’t use a hyphen as the first or last character, or immediately after another hyphen.
r#match(RuleMatch)
/set_match(Option<RuleMatch>)
:
required: trueThe rule match.
priority(i32)
/set_priority(Option<i32>)
:
required: trueThe priority assigned to the rule. Each rule for a specific listener must have a unique priority. The lower the priority number the higher the priority.
action(RuleAction)
/set_action(Option<RuleAction>)
:
required: trueThe action for the default rule.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren’t identical, the retry fails.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe tags for the rule.
- On success, responds with
CreateRuleOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name (ARN) of the rule.
id(Option<String>)
:The ID of the rule.
name(Option<String>)
:The name of the rule.
r#match(Option<RuleMatch>)
:The rule match. The
RuleMatch
must be anHttpMatch
. This means that the rule should be an exact match on HTTP constraints which are made up of the HTTP method, path, and header.priority(Option<i32>)
:The priority assigned to the rule. The lower the priority number the higher the priority.
action(Option<RuleAction>)
:The rule action.
- On failure, responds with
SdkError<CreateRuleError>
Source§impl Client
impl Client
Sourcepub fn create_service(&self) -> CreateServiceFluentBuilder
pub fn create_service(&self) -> CreateServiceFluentBuilder
Constructs a fluent builder for the CreateService
operation.
- The fluent builder is configurable:
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren’t identical, the retry fails.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the service. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can’t use a hyphen as the first or last character, or immediately after another hyphen.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe tags for the service.
custom_domain_name(impl Into<String>)
/set_custom_domain_name(Option<String>)
:
required: falseThe custom domain name of the service.
certificate_arn(impl Into<String>)
/set_certificate_arn(Option<String>)
:
required: falseThe Amazon Resource Name (ARN) of the certificate.
auth_type(AuthType)
/set_auth_type(Option<AuthType>)
:
required: falseThe type of IAM policy.
-
NONE
: The resource does not use an IAM policy. This is the default. -
AWS_IAM
: The resource uses an IAM policy. When this type is used, auth is enabled and an auth policy is required.
-
- On success, responds with
CreateServiceOutput
with field(s):id(Option<String>)
:The ID of the service.
arn(Option<String>)
:The Amazon Resource Name (ARN) of the service.
name(Option<String>)
:The name of the service.
custom_domain_name(Option<String>)
:The custom domain name of the service.
certificate_arn(Option<String>)
:The Amazon Resource Name (ARN) of the certificate.
status(Option<ServiceStatus>)
:The status. If the status is
CREATE_FAILED
, you must delete and recreate the service.auth_type(Option<AuthType>)
:The type of IAM policy.
dns_entry(Option<DnsEntry>)
:The public DNS name of the service.
- On failure, responds with
SdkError<CreateServiceError>
Source§impl Client
impl Client
Sourcepub fn create_service_network(&self) -> CreateServiceNetworkFluentBuilder
pub fn create_service_network(&self) -> CreateServiceNetworkFluentBuilder
Constructs a fluent builder for the CreateServiceNetwork
operation.
- The fluent builder is configurable:
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren’t identical, the retry fails.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the service network. The name must be unique to the account. The valid characters are a-z, 0-9, and hyphens (-). You can’t use a hyphen as the first or last character, or immediately after another hyphen.
auth_type(AuthType)
/set_auth_type(Option<AuthType>)
:
required: falseThe type of IAM policy.
-
NONE
: The resource does not use an IAM policy. This is the default. -
AWS_IAM
: The resource uses an IAM policy. When this type is used, auth is enabled and an auth policy is required.
-
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe tags for the service network.
sharing_config(SharingConfig)
/set_sharing_config(Option<SharingConfig>)
:
required: falseSpecify if the service network should be enabled for sharing.
- On success, responds with
CreateServiceNetworkOutput
with field(s):id(Option<String>)
:The ID of the service network.
name(Option<String>)
:The name of the service network.
arn(Option<String>)
:The Amazon Resource Name (ARN) of the service network.
sharing_config(Option<SharingConfig>)
:Specifies if the service network is enabled for sharing.
auth_type(Option<AuthType>)
:The type of IAM policy.
- On failure, responds with
SdkError<CreateServiceNetworkError>
Source§impl Client
impl Client
Sourcepub fn create_service_network_resource_association(
&self,
) -> CreateServiceNetworkResourceAssociationFluentBuilder
pub fn create_service_network_resource_association( &self, ) -> CreateServiceNetworkResourceAssociationFluentBuilder
Constructs a fluent builder for the CreateServiceNetworkResourceAssociation
operation.
- The fluent builder is configurable:
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren’t identical, the retry fails.
resource_configuration_identifier(impl Into<String>)
/set_resource_configuration_identifier(Option<String>)
:
required: trueThe ID of the resource configuration to associate with the service network.
service_network_identifier(impl Into<String>)
/set_service_network_identifier(Option<String>)
:
required: trueThe ID of the service network to associate with the resource configuration.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe tags for the association.
- On success, responds with
CreateServiceNetworkResourceAssociationOutput
with field(s):id(Option<String>)
:The ID of the association.
arn(Option<String>)
:The Amazon Resource Name (ARN) of the association.
status(Option<ServiceNetworkResourceAssociationStatus>)
:The status of the association.
created_by(Option<String>)
:The ID of the account that created the association.
- On failure, responds with
SdkError<CreateServiceNetworkResourceAssociationError>
Source§impl Client
impl Client
Sourcepub fn create_service_network_service_association(
&self,
) -> CreateServiceNetworkServiceAssociationFluentBuilder
pub fn create_service_network_service_association( &self, ) -> CreateServiceNetworkServiceAssociationFluentBuilder
Constructs a fluent builder for the CreateServiceNetworkServiceAssociation
operation.
- The fluent builder is configurable:
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren’t identical, the retry fails.
service_identifier(impl Into<String>)
/set_service_identifier(Option<String>)
:
required: trueThe ID or ARN of the service.
service_network_identifier(impl Into<String>)
/set_service_network_identifier(Option<String>)
:
required: trueThe ID or ARN of the service network. You must use an ARN if the resources are in different accounts.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe tags for the association.
- On success, responds with
CreateServiceNetworkServiceAssociationOutput
with field(s):id(Option<String>)
:The ID of the association.
status(Option<ServiceNetworkServiceAssociationStatus>)
:The association status.
arn(Option<String>)
:The Amazon Resource Name (ARN) of the association.
created_by(Option<String>)
:The account that created the association.
custom_domain_name(Option<String>)
:The custom domain name of the service.
dns_entry(Option<DnsEntry>)
:The DNS name of the service.
- On failure, responds with
SdkError<CreateServiceNetworkServiceAssociationError>
Source§impl Client
impl Client
Sourcepub fn create_service_network_vpc_association(
&self,
) -> CreateServiceNetworkVpcAssociationFluentBuilder
pub fn create_service_network_vpc_association( &self, ) -> CreateServiceNetworkVpcAssociationFluentBuilder
Constructs a fluent builder for the CreateServiceNetworkVpcAssociation
operation.
- The fluent builder is configurable:
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren’t identical, the retry fails.
service_network_identifier(impl Into<String>)
/set_service_network_identifier(Option<String>)
:
required: trueThe ID or ARN of the service network. You must use an ARN if the resources are in different accounts.
vpc_identifier(impl Into<String>)
/set_vpc_identifier(Option<String>)
:
required: trueThe ID of the VPC.
security_group_ids(impl Into<String>)
/set_security_group_ids(Option<Vec::<String>>)
:
required: falseThe IDs of the security groups. Security groups aren’t added by default. You can add a security group to apply network level controls to control which resources in a VPC are allowed to access the service network and its services. For more information, see Control traffic to resources using security groups in the Amazon VPC User Guide.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe tags for the association.
- On success, responds with
CreateServiceNetworkVpcAssociationOutput
with field(s):id(Option<String>)
:The ID of the association.
status(Option<ServiceNetworkVpcAssociationStatus>)
:The association status.
arn(Option<String>)
:The Amazon Resource Name (ARN) of the association.
created_by(Option<String>)
:The account that created the association.
security_group_ids(Option<Vec::<String>>)
:The IDs of the security groups.
- On failure, responds with
SdkError<CreateServiceNetworkVpcAssociationError>
Source§impl Client
impl Client
Sourcepub fn create_target_group(&self) -> CreateTargetGroupFluentBuilder
pub fn create_target_group(&self) -> CreateTargetGroupFluentBuilder
Constructs a fluent builder for the CreateTargetGroup
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the target group. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can’t use a hyphen as the first or last character, or immediately after another hyphen.
r#type(TargetGroupType)
/set_type(Option<TargetGroupType>)
:
required: trueThe type of target group.
config(TargetGroupConfig)
/set_config(Option<TargetGroupConfig>)
:
required: falseThe target group configuration.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren’t identical, the retry fails.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe tags for the target group.
- On success, responds with
CreateTargetGroupOutput
with field(s):id(Option<String>)
:The ID of the target group.
arn(Option<String>)
:The Amazon Resource Name (ARN) of the target group.
name(Option<String>)
:The name of the target group.
r#type(Option<TargetGroupType>)
:The type of target group.
config(Option<TargetGroupConfig>)
:The target group configuration.
status(Option<TargetGroupStatus>)
:The status. You can retry the operation if the status is
CREATE_FAILED
. However, if you retry it while the status isCREATE_IN_PROGRESS
, there is no change in the status.
- On failure, responds with
SdkError<CreateTargetGroupError>
Source§impl Client
impl Client
Sourcepub fn delete_access_log_subscription(
&self,
) -> DeleteAccessLogSubscriptionFluentBuilder
pub fn delete_access_log_subscription( &self, ) -> DeleteAccessLogSubscriptionFluentBuilder
Constructs a fluent builder for the DeleteAccessLogSubscription
operation.
- The fluent builder is configurable:
access_log_subscription_identifier(impl Into<String>)
/set_access_log_subscription_identifier(Option<String>)
:
required: trueThe ID or ARN of the access log subscription.
- On success, responds with
DeleteAccessLogSubscriptionOutput
- On failure, responds with
SdkError<DeleteAccessLogSubscriptionError>
Source§impl Client
impl Client
Sourcepub fn delete_auth_policy(&self) -> DeleteAuthPolicyFluentBuilder
pub fn delete_auth_policy(&self) -> DeleteAuthPolicyFluentBuilder
Constructs a fluent builder for the DeleteAuthPolicy
operation.
- The fluent builder is configurable:
resource_identifier(impl Into<String>)
/set_resource_identifier(Option<String>)
:
required: trueThe ID or ARN of the resource.
- On success, responds with
DeleteAuthPolicyOutput
- On failure, responds with
SdkError<DeleteAuthPolicyError>
Source§impl Client
impl Client
Sourcepub fn delete_listener(&self) -> DeleteListenerFluentBuilder
pub fn delete_listener(&self) -> DeleteListenerFluentBuilder
Constructs a fluent builder for the DeleteListener
operation.
- The fluent builder is configurable:
service_identifier(impl Into<String>)
/set_service_identifier(Option<String>)
:
required: trueThe ID or ARN of the service.
listener_identifier(impl Into<String>)
/set_listener_identifier(Option<String>)
:
required: trueThe ID or ARN of the listener.
- On success, responds with
DeleteListenerOutput
- On failure, responds with
SdkError<DeleteListenerError>
Source§impl Client
impl Client
Sourcepub fn delete_resource_configuration(
&self,
) -> DeleteResourceConfigurationFluentBuilder
pub fn delete_resource_configuration( &self, ) -> DeleteResourceConfigurationFluentBuilder
Constructs a fluent builder for the DeleteResourceConfiguration
operation.
- The fluent builder is configurable:
resource_configuration_identifier(impl Into<String>)
/set_resource_configuration_identifier(Option<String>)
:
required: trueThe ID or ARN of the resource configuration.
- On success, responds with
DeleteResourceConfigurationOutput
- On failure, responds with
SdkError<DeleteResourceConfigurationError>
Source§impl Client
impl Client
Sourcepub fn delete_resource_endpoint_association(
&self,
) -> DeleteResourceEndpointAssociationFluentBuilder
pub fn delete_resource_endpoint_association( &self, ) -> DeleteResourceEndpointAssociationFluentBuilder
Constructs a fluent builder for the DeleteResourceEndpointAssociation
operation.
- The fluent builder is configurable:
resource_endpoint_association_identifier(impl Into<String>)
/set_resource_endpoint_association_identifier(Option<String>)
:
required: trueThe ID or ARN of the association.
- On success, responds with
DeleteResourceEndpointAssociationOutput
with field(s):id(Option<String>)
:The ID of the association.
arn(Option<String>)
:The Amazon Resource Name (ARN) of the association.
resource_configuration_id(Option<String>)
:The ID of the resource configuration.
resource_configuration_arn(Option<String>)
:The Amazon Resource Name (ARN) of the resource configuration associated with the VPC endpoint of type resource.
vpc_endpoint_id(Option<String>)
:The ID of the resource VPC endpoint that is associated with the resource configuration.
- On failure, responds with
SdkError<DeleteResourceEndpointAssociationError>
Source§impl Client
impl Client
Sourcepub fn delete_resource_gateway(&self) -> DeleteResourceGatewayFluentBuilder
pub fn delete_resource_gateway(&self) -> DeleteResourceGatewayFluentBuilder
Constructs a fluent builder for the DeleteResourceGateway
operation.
- The fluent builder is configurable:
resource_gateway_identifier(impl Into<String>)
/set_resource_gateway_identifier(Option<String>)
:
required: trueThe ID or ARN of the resource gateway.
- On success, responds with
DeleteResourceGatewayOutput
with field(s):id(Option<String>)
:The ID of the resource gateway.
arn(Option<String>)
:The Amazon Resource Name (ARN) of the resource gateway.
name(Option<String>)
:The name of the resource gateway.
status(Option<ResourceGatewayStatus>)
:The status of the resource gateway.
- On failure, responds with
SdkError<DeleteResourceGatewayError>
Source§impl Client
impl Client
Sourcepub fn delete_resource_policy(&self) -> DeleteResourcePolicyFluentBuilder
pub fn delete_resource_policy(&self) -> DeleteResourcePolicyFluentBuilder
Constructs a fluent builder for the DeleteResourcePolicy
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the resource.
- On success, responds with
DeleteResourcePolicyOutput
- On failure, responds with
SdkError<DeleteResourcePolicyError>
Source§impl Client
impl Client
Sourcepub fn delete_rule(&self) -> DeleteRuleFluentBuilder
pub fn delete_rule(&self) -> DeleteRuleFluentBuilder
Constructs a fluent builder for the DeleteRule
operation.
- The fluent builder is configurable:
service_identifier(impl Into<String>)
/set_service_identifier(Option<String>)
:
required: trueThe ID or ARN of the service.
listener_identifier(impl Into<String>)
/set_listener_identifier(Option<String>)
:
required: trueThe ID or ARN of the listener.
rule_identifier(impl Into<String>)
/set_rule_identifier(Option<String>)
:
required: trueThe ID or ARN of the rule.
- On success, responds with
DeleteRuleOutput
- On failure, responds with
SdkError<DeleteRuleError>
Source§impl Client
impl Client
Sourcepub fn delete_service(&self) -> DeleteServiceFluentBuilder
pub fn delete_service(&self) -> DeleteServiceFluentBuilder
Constructs a fluent builder for the DeleteService
operation.
- The fluent builder is configurable:
service_identifier(impl Into<String>)
/set_service_identifier(Option<String>)
:
required: trueThe ID or ARN of the service.
- On success, responds with
DeleteServiceOutput
with field(s):id(Option<String>)
:The ID of the service.
arn(Option<String>)
:The Amazon Resource Name (ARN) of the service.
name(Option<String>)
:The name of the service.
status(Option<ServiceStatus>)
:The status. You can retry the operation if the status is
DELETE_FAILED
. However, if you retry it while the status isDELETE_IN_PROGRESS
, the status doesn’t change.
- On failure, responds with
SdkError<DeleteServiceError>
Source§impl Client
impl Client
Sourcepub fn delete_service_network(&self) -> DeleteServiceNetworkFluentBuilder
pub fn delete_service_network(&self) -> DeleteServiceNetworkFluentBuilder
Constructs a fluent builder for the DeleteServiceNetwork
operation.
- The fluent builder is configurable:
service_network_identifier(impl Into<String>)
/set_service_network_identifier(Option<String>)
:
required: trueThe ID or ARN of the service network.
- On success, responds with
DeleteServiceNetworkOutput
- On failure, responds with
SdkError<DeleteServiceNetworkError>
Source§impl Client
impl Client
Sourcepub fn delete_service_network_resource_association(
&self,
) -> DeleteServiceNetworkResourceAssociationFluentBuilder
pub fn delete_service_network_resource_association( &self, ) -> DeleteServiceNetworkResourceAssociationFluentBuilder
Constructs a fluent builder for the DeleteServiceNetworkResourceAssociation
operation.
- The fluent builder is configurable:
service_network_resource_association_identifier(impl Into<String>)
/set_service_network_resource_association_identifier(Option<String>)
:
required: trueThe ID of the association.
- On success, responds with
DeleteServiceNetworkResourceAssociationOutput
with field(s):id(Option<String>)
:The ID of the association.
arn(Option<String>)
:The Amazon Resource Name (ARN) of the association.
status(Option<ServiceNetworkResourceAssociationStatus>)
:The status of the association.
- On failure, responds with
SdkError<DeleteServiceNetworkResourceAssociationError>
Source§impl Client
impl Client
Sourcepub fn delete_service_network_service_association(
&self,
) -> DeleteServiceNetworkServiceAssociationFluentBuilder
pub fn delete_service_network_service_association( &self, ) -> DeleteServiceNetworkServiceAssociationFluentBuilder
Constructs a fluent builder for the DeleteServiceNetworkServiceAssociation
operation.
- The fluent builder is configurable:
service_network_service_association_identifier(impl Into<String>)
/set_service_network_service_association_identifier(Option<String>)
:
required: trueThe ID or ARN of the association.
- On success, responds with
DeleteServiceNetworkServiceAssociationOutput
with field(s):id(Option<String>)
:The ID of the association.
status(Option<ServiceNetworkServiceAssociationStatus>)
:The status. You can retry the operation if the status is
DELETE_FAILED
. However, if you retry it when the status isDELETE_IN_PROGRESS
, there is no change in the status.arn(Option<String>)
:The Amazon Resource Name (ARN) of the association.
- On failure, responds with
SdkError<DeleteServiceNetworkServiceAssociationError>
Source§impl Client
impl Client
Sourcepub fn delete_service_network_vpc_association(
&self,
) -> DeleteServiceNetworkVpcAssociationFluentBuilder
pub fn delete_service_network_vpc_association( &self, ) -> DeleteServiceNetworkVpcAssociationFluentBuilder
Constructs a fluent builder for the DeleteServiceNetworkVpcAssociation
operation.
- The fluent builder is configurable:
service_network_vpc_association_identifier(impl Into<String>)
/set_service_network_vpc_association_identifier(Option<String>)
:
required: trueThe ID or ARN of the association.
- On success, responds with
DeleteServiceNetworkVpcAssociationOutput
with field(s):id(Option<String>)
:The ID of the association.
status(Option<ServiceNetworkVpcAssociationStatus>)
:The status. You can retry the operation if the status is
DELETE_FAILED
. However, if you retry it while the status isDELETE_IN_PROGRESS
, there is no change in the status.arn(Option<String>)
:The Amazon Resource Name (ARN) of the association.
- On failure, responds with
SdkError<DeleteServiceNetworkVpcAssociationError>
Source§impl Client
impl Client
Sourcepub fn delete_target_group(&self) -> DeleteTargetGroupFluentBuilder
pub fn delete_target_group(&self) -> DeleteTargetGroupFluentBuilder
Constructs a fluent builder for the DeleteTargetGroup
operation.
- The fluent builder is configurable:
target_group_identifier(impl Into<String>)
/set_target_group_identifier(Option<String>)
:
required: trueThe ID or ARN of the target group.
- On success, responds with
DeleteTargetGroupOutput
with field(s):id(Option<String>)
:The ID of the target group.
arn(Option<String>)
:The Amazon Resource Name (ARN) of the target group.
status(Option<TargetGroupStatus>)
:The status. You can retry the operation if the status is
DELETE_FAILED
. However, if you retry it while the status isDELETE_IN_PROGRESS
, the status doesn’t change.
- On failure, responds with
SdkError<DeleteTargetGroupError>
Source§impl Client
impl Client
Sourcepub fn deregister_targets(&self) -> DeregisterTargetsFluentBuilder
pub fn deregister_targets(&self) -> DeregisterTargetsFluentBuilder
Constructs a fluent builder for the DeregisterTargets
operation.
- The fluent builder is configurable:
target_group_identifier(impl Into<String>)
/set_target_group_identifier(Option<String>)
:
required: trueThe ID or ARN of the target group.
targets(Target)
/set_targets(Option<Vec::<Target>>)
:
required: trueThe targets to deregister.
- On success, responds with
DeregisterTargetsOutput
with field(s):successful(Option<Vec::<Target>>)
:The targets that were successfully deregistered.
unsuccessful(Option<Vec::<TargetFailure>>)
:The targets that the operation couldn’t deregister.
- On failure, responds with
SdkError<DeregisterTargetsError>
Source§impl Client
impl Client
Sourcepub fn get_access_log_subscription(
&self,
) -> GetAccessLogSubscriptionFluentBuilder
pub fn get_access_log_subscription( &self, ) -> GetAccessLogSubscriptionFluentBuilder
Constructs a fluent builder for the GetAccessLogSubscription
operation.
- The fluent builder is configurable:
access_log_subscription_identifier(impl Into<String>)
/set_access_log_subscription_identifier(Option<String>)
:
required: trueThe ID or ARN of the access log subscription.
- On success, responds with
GetAccessLogSubscriptionOutput
with field(s):id(String)
:The ID of the access log subscription.
arn(String)
:The Amazon Resource Name (ARN) of the access log subscription.
resource_id(String)
:The ID of the service network or service.
resource_arn(String)
:The Amazon Resource Name (ARN) of the service network or service.
destination_arn(String)
:The Amazon Resource Name (ARN) of the access log destination.
service_network_log_type(Option<ServiceNetworkLogType>)
:The log type for the service network.
created_at(DateTime)
:The date and time that the access log subscription was created, in ISO-8601 format.
last_updated_at(DateTime)
:The date and time that the access log subscription was last updated, in ISO-8601 format.
- On failure, responds with
SdkError<GetAccessLogSubscriptionError>
Source§impl Client
impl Client
Sourcepub fn get_auth_policy(&self) -> GetAuthPolicyFluentBuilder
pub fn get_auth_policy(&self) -> GetAuthPolicyFluentBuilder
Constructs a fluent builder for the GetAuthPolicy
operation.
- The fluent builder is configurable:
resource_identifier(impl Into<String>)
/set_resource_identifier(Option<String>)
:
required: trueThe ID or ARN of the service network or service.
- On success, responds with
GetAuthPolicyOutput
with field(s):policy(Option<String>)
:The auth policy.
state(Option<AuthPolicyState>)
:The state of the auth policy. The auth policy is only active when the auth type is set to
AWS_IAM
. If you provide a policy, then authentication and authorization decisions are made based on this policy and the client’s IAM policy. If the auth type isNONE
, then any auth policy that you provide remains inactive. For more information, see Create a service network in the Amazon VPC Lattice User Guide.created_at(Option<DateTime>)
:The date and time that the auth policy was created, in ISO-8601 format.
last_updated_at(Option<DateTime>)
:The date and time that the auth policy was last updated, in ISO-8601 format.
- On failure, responds with
SdkError<GetAuthPolicyError>
Source§impl Client
impl Client
Sourcepub fn get_listener(&self) -> GetListenerFluentBuilder
pub fn get_listener(&self) -> GetListenerFluentBuilder
Constructs a fluent builder for the GetListener
operation.
- The fluent builder is configurable:
service_identifier(impl Into<String>)
/set_service_identifier(Option<String>)
:
required: trueThe ID or ARN of the service.
listener_identifier(impl Into<String>)
/set_listener_identifier(Option<String>)
:
required: trueThe ID or ARN of the listener.
- On success, responds with
GetListenerOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name (ARN) of the listener.
id(Option<String>)
:The ID of the listener.
name(Option<String>)
:The name of the listener.
protocol(Option<ListenerProtocol>)
:The listener protocol.
port(Option<i32>)
:The listener port.
service_arn(Option<String>)
:The Amazon Resource Name (ARN) of the service.
service_id(Option<String>)
:The ID of the service.
default_action(Option<RuleAction>)
:The actions for the default listener rule.
created_at(Option<DateTime>)
:The date and time that the listener was created, in ISO-8601 format.
last_updated_at(Option<DateTime>)
:The date and time that the listener was last updated, in ISO-8601 format.
- On failure, responds with
SdkError<GetListenerError>
Source§impl Client
impl Client
Sourcepub fn get_resource_configuration(
&self,
) -> GetResourceConfigurationFluentBuilder
pub fn get_resource_configuration( &self, ) -> GetResourceConfigurationFluentBuilder
Constructs a fluent builder for the GetResourceConfiguration
operation.
- The fluent builder is configurable:
resource_configuration_identifier(impl Into<String>)
/set_resource_configuration_identifier(Option<String>)
:
required: trueThe ID of the resource configuration.
- On success, responds with
GetResourceConfigurationOutput
with field(s):id(Option<String>)
:The ID of the resource configuration.
name(Option<String>)
:The name of the resource configuration.
arn(Option<String>)
:The Amazon Resource Name (ARN) of the resource configuration.
resource_gateway_id(Option<String>)
:The ID of the resource gateway used to connect to the resource configuration in a given VPC. You can specify the resource gateway identifier only for resource configurations with type SINGLE, GROUP, or ARN.
resource_configuration_group_id(Option<String>)
:The ID of the group resource configuration.
r#type(Option<ResourceConfigurationType>)
:The type of resource configuration.
-
SINGLE
- A single resource. -
GROUP
- A group of resources. -
CHILD
- A single resource that is part of a group resource configuration. -
ARN
- An Amazon Web Services resource.
-
allow_association_to_shareable_service_network(Option<bool>)
:Specifies whether the resource configuration is associated with a sharable service network.
port_ranges(Option<Vec::<String>>)
:The TCP port ranges that a consumer can use to access a resource configuration. You can separate port ranges with a comma. Example: 1-65535 or 1,2,22-30
protocol(Option<ProtocolType>)
:The TCP protocol accepted by the specified resource configuration.
custom_domain_name(Option<String>)
:The custom domain name of the resource configuration.
status(Option<ResourceConfigurationStatus>)
:The status of the resource configuration.
resource_configuration_definition(Option<ResourceConfigurationDefinition>)
:The resource configuration.
created_at(Option<DateTime>)
:The date and time that the resource configuration was created, in ISO-8601 format.
amazon_managed(Option<bool>)
:Indicates whether the resource configuration was created and is managed by Amazon.
failure_reason(Option<String>)
:The reason the create-resource-configuration request failed.
last_updated_at(Option<DateTime>)
:The most recent date and time that the resource configuration was updated, in ISO-8601 format.
- On failure, responds with
SdkError<GetResourceConfigurationError>
Source§impl Client
impl Client
Sourcepub fn get_resource_gateway(&self) -> GetResourceGatewayFluentBuilder
pub fn get_resource_gateway(&self) -> GetResourceGatewayFluentBuilder
Constructs a fluent builder for the GetResourceGateway
operation.
- The fluent builder is configurable:
resource_gateway_identifier(impl Into<String>)
/set_resource_gateway_identifier(Option<String>)
:
required: trueThe ID of the resource gateway.
- On success, responds with
GetResourceGatewayOutput
with field(s):name(Option<String>)
:The name of the resource gateway.
id(Option<String>)
:The ID of the resource gateway.
arn(Option<String>)
:The Amazon Resource Name (ARN) of the resource gateway.
status(Option<ResourceGatewayStatus>)
:The status for the resource gateway.
vpc_id(Option<String>)
:The ID of the VPC for the resource gateway.
subnet_ids(Option<Vec::<String>>)
:The IDs of the VPC subnets for resource gateway.
security_group_ids(Option<Vec::<String>>)
:The security group IDs associated with the resource gateway.
ip_address_type(Option<ResourceGatewayIpAddressType>)
:The type of IP address for the resource gateway.
created_at(Option<DateTime>)
:The date and time that the resource gateway was created, in ISO-8601 format.
last_updated_at(Option<DateTime>)
:The date and time that the resource gateway was last updated, in ISO-8601 format.
- On failure, responds with
SdkError<GetResourceGatewayError>
Source§impl Client
impl Client
Sourcepub fn get_resource_policy(&self) -> GetResourcePolicyFluentBuilder
pub fn get_resource_policy(&self) -> GetResourcePolicyFluentBuilder
Constructs a fluent builder for the GetResourcePolicy
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the service network or service.
- On success, responds with
GetResourcePolicyOutput
with field(s):policy(Option<String>)
:An IAM policy.
- On failure, responds with
SdkError<GetResourcePolicyError>
Source§impl Client
impl Client
Sourcepub fn get_rule(&self) -> GetRuleFluentBuilder
pub fn get_rule(&self) -> GetRuleFluentBuilder
Constructs a fluent builder for the GetRule
operation.
- The fluent builder is configurable:
service_identifier(impl Into<String>)
/set_service_identifier(Option<String>)
:
required: trueThe ID or ARN of the service.
listener_identifier(impl Into<String>)
/set_listener_identifier(Option<String>)
:
required: trueThe ID or ARN of the listener.
rule_identifier(impl Into<String>)
/set_rule_identifier(Option<String>)
:
required: trueThe ID or ARN of the listener rule.
- On success, responds with
GetRuleOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name (ARN) of the listener.
id(Option<String>)
:The ID of the listener.
name(Option<String>)
:The name of the listener.
is_default(Option<bool>)
:Indicates whether this is the default rule.
r#match(Option<RuleMatch>)
:The rule match.
priority(Option<i32>)
:The priority level for the specified rule.
action(Option<RuleAction>)
:The action for the default rule.
created_at(Option<DateTime>)
:The date and time that the listener rule was created, in ISO-8601 format.
last_updated_at(Option<DateTime>)
:The date and time that the listener rule was last updated, in ISO-8601 format.
- On failure, responds with
SdkError<GetRuleError>
Source§impl Client
impl Client
Sourcepub fn get_service(&self) -> GetServiceFluentBuilder
pub fn get_service(&self) -> GetServiceFluentBuilder
Constructs a fluent builder for the GetService
operation.
- The fluent builder is configurable:
service_identifier(impl Into<String>)
/set_service_identifier(Option<String>)
:
required: trueThe ID or ARN of the service.
- On success, responds with
GetServiceOutput
with field(s):id(Option<String>)
:The ID of the service.
name(Option<String>)
:The name of the service.
arn(Option<String>)
:The Amazon Resource Name (ARN) of the service.
created_at(Option<DateTime>)
:The date and time that the service was created, in ISO-8601 format.
last_updated_at(Option<DateTime>)
:The date and time that the service was last updated, in ISO-8601 format.
dns_entry(Option<DnsEntry>)
:The DNS name of the service.
custom_domain_name(Option<String>)
:The custom domain name of the service.
certificate_arn(Option<String>)
:The Amazon Resource Name (ARN) of the certificate.
status(Option<ServiceStatus>)
:The status of the service.
auth_type(Option<AuthType>)
:The type of IAM policy.
failure_code(Option<String>)
:The failure code.
failure_message(Option<String>)
:The failure message.
- On failure, responds with
SdkError<GetServiceError>
Source§impl Client
impl Client
Sourcepub fn get_service_network(&self) -> GetServiceNetworkFluentBuilder
pub fn get_service_network(&self) -> GetServiceNetworkFluentBuilder
Constructs a fluent builder for the GetServiceNetwork
operation.
- The fluent builder is configurable:
service_network_identifier(impl Into<String>)
/set_service_network_identifier(Option<String>)
:
required: trueThe ID or ARN of the service network.
- On success, responds with
GetServiceNetworkOutput
with field(s):id(Option<String>)
:The ID of the service network.
name(Option<String>)
:The name of the service network.
created_at(Option<DateTime>)
:The date and time that the service network was created, in ISO-8601 format.
last_updated_at(Option<DateTime>)
:The date and time of the last update, in ISO-8601 format.
arn(Option<String>)
:The Amazon Resource Name (ARN) of the service network.
auth_type(Option<AuthType>)
:The type of IAM policy.
sharing_config(Option<SharingConfig>)
:Specifies if the service network is enabled for sharing.
number_of_associated_vpcs(Option<i64>)
:The number of VPCs associated with the service network.
number_of_associated_services(Option<i64>)
:The number of services associated with the service network.
- On failure, responds with
SdkError<GetServiceNetworkError>
Source§impl Client
impl Client
Sourcepub fn get_service_network_resource_association(
&self,
) -> GetServiceNetworkResourceAssociationFluentBuilder
pub fn get_service_network_resource_association( &self, ) -> GetServiceNetworkResourceAssociationFluentBuilder
Constructs a fluent builder for the GetServiceNetworkResourceAssociation
operation.
- The fluent builder is configurable:
service_network_resource_association_identifier(impl Into<String>)
/set_service_network_resource_association_identifier(Option<String>)
:
required: trueThe ID of the association.
- On success, responds with
GetServiceNetworkResourceAssociationOutput
with field(s):id(Option<String>)
:The ID of the association.
arn(Option<String>)
:The Amazon Resource Name (ARN) of the association.
status(Option<ServiceNetworkResourceAssociationStatus>)
:The status of the association.
created_by(Option<String>)
:The account that created the association.
created_at(Option<DateTime>)
:The date and time that the association was created, in ISO-8601 format.
resource_configuration_id(Option<String>)
:The ID of the resource configuration that is associated with the service network.
resource_configuration_arn(Option<String>)
:The Amazon Resource Name (ARN) of the association.
resource_configuration_name(Option<String>)
:The name of the resource configuration that is associated with the service network.
service_network_id(Option<String>)
:The ID of the service network that is associated with the resource configuration.
service_network_arn(Option<String>)
:The Amazon Resource Name (ARN) of the service network that is associated with the resource configuration.
service_network_name(Option<String>)
:The name of the service network that is associated with the resource configuration.
failure_reason(Option<String>)
:The reason the association request failed.
failure_code(Option<String>)
:The failure code.
last_updated_at(Option<DateTime>)
:The most recent date and time that the association was updated, in ISO-8601 format.
private_dns_entry(Option<DnsEntry>)
:The private DNS entry for the service.
dns_entry(Option<DnsEntry>)
:The DNS entry for the service.
is_managed_association(Option<bool>)
:Indicates whether the association is managed by Amazon.
- On failure, responds with
SdkError<GetServiceNetworkResourceAssociationError>
Source§impl Client
impl Client
Sourcepub fn get_service_network_service_association(
&self,
) -> GetServiceNetworkServiceAssociationFluentBuilder
pub fn get_service_network_service_association( &self, ) -> GetServiceNetworkServiceAssociationFluentBuilder
Constructs a fluent builder for the GetServiceNetworkServiceAssociation
operation.
- The fluent builder is configurable:
service_network_service_association_identifier(impl Into<String>)
/set_service_network_service_association_identifier(Option<String>)
:
required: trueThe ID or ARN of the association.
- On success, responds with
GetServiceNetworkServiceAssociationOutput
with field(s):id(Option<String>)
:The ID of the service network and service association.
status(Option<ServiceNetworkServiceAssociationStatus>)
:The status of the association.
arn(Option<String>)
:The Amazon Resource Name (ARN) of the association.
created_by(Option<String>)
:The account that created the association.
created_at(Option<DateTime>)
:The date and time that the association was created, in ISO-8601 format.
service_id(Option<String>)
:The ID of the service.
service_name(Option<String>)
:The name of the service.
service_arn(Option<String>)
:The Amazon Resource Name (ARN) of the service.
service_network_id(Option<String>)
:The ID of the service network.
service_network_name(Option<String>)
:The name of the service network.
service_network_arn(Option<String>)
:The Amazon Resource Name (ARN) of the service network.
dns_entry(Option<DnsEntry>)
:The DNS name of the service.
custom_domain_name(Option<String>)
:The custom domain name of the service.
failure_message(Option<String>)
:The failure message.
failure_code(Option<String>)
:The failure code.
- On failure, responds with
SdkError<GetServiceNetworkServiceAssociationError>
Source§impl Client
impl Client
Sourcepub fn get_service_network_vpc_association(
&self,
) -> GetServiceNetworkVpcAssociationFluentBuilder
pub fn get_service_network_vpc_association( &self, ) -> GetServiceNetworkVpcAssociationFluentBuilder
Constructs a fluent builder for the GetServiceNetworkVpcAssociation
operation.
- The fluent builder is configurable:
service_network_vpc_association_identifier(impl Into<String>)
/set_service_network_vpc_association_identifier(Option<String>)
:
required: trueThe ID or ARN of the association.
- On success, responds with
GetServiceNetworkVpcAssociationOutput
with field(s):id(Option<String>)
:The ID of the association.
status(Option<ServiceNetworkVpcAssociationStatus>)
:The status of the association.
arn(Option<String>)
:The Amazon Resource Name (ARN) of the association.
created_by(Option<String>)
:The account that created the association.
created_at(Option<DateTime>)
:The date and time that the association was created, in ISO-8601 format.
service_network_id(Option<String>)
:The ID of the service network.
service_network_name(Option<String>)
:The name of the service network.
service_network_arn(Option<String>)
:The Amazon Resource Name (ARN) of the service network.
vpc_id(Option<String>)
:The ID of the VPC.
security_group_ids(Option<Vec::<String>>)
:The IDs of the security groups.
failure_message(Option<String>)
:The failure message.
failure_code(Option<String>)
:The failure code.
last_updated_at(Option<DateTime>)
:The date and time that the association was last updated, in ISO-8601 format.
- On failure, responds with
SdkError<GetServiceNetworkVpcAssociationError>
Source§impl Client
impl Client
Sourcepub fn get_target_group(&self) -> GetTargetGroupFluentBuilder
pub fn get_target_group(&self) -> GetTargetGroupFluentBuilder
Constructs a fluent builder for the GetTargetGroup
operation.
- The fluent builder is configurable:
target_group_identifier(impl Into<String>)
/set_target_group_identifier(Option<String>)
:
required: trueThe ID or ARN of the target group.
- On success, responds with
GetTargetGroupOutput
with field(s):id(Option<String>)
:The ID of the target group.
arn(Option<String>)
:The Amazon Resource Name (ARN) of the target group.
name(Option<String>)
:The name of the target group.
r#type(Option<TargetGroupType>)
:The target group type.
config(Option<TargetGroupConfig>)
:The target group configuration.
created_at(Option<DateTime>)
:The date and time that the target group was created, in ISO-8601 format.
last_updated_at(Option<DateTime>)
:The date and time that the target group was last updated, in ISO-8601 format.
status(Option<TargetGroupStatus>)
:The status.
service_arns(Option<Vec::<String>>)
:The Amazon Resource Names (ARNs) of the service.
failure_message(Option<String>)
:The failure message.
failure_code(Option<String>)
:The failure code.
- On failure, responds with
SdkError<GetTargetGroupError>
Source§impl Client
impl Client
Sourcepub fn list_access_log_subscriptions(
&self,
) -> ListAccessLogSubscriptionsFluentBuilder
pub fn list_access_log_subscriptions( &self, ) -> ListAccessLogSubscriptionsFluentBuilder
Constructs a fluent builder for the ListAccessLogSubscriptions
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
resource_identifier(impl Into<String>)
/set_resource_identifier(Option<String>)
:
required: trueThe ID or ARN of the service network or service.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA pagination token for the next page of results.
- On success, responds with
ListAccessLogSubscriptionsOutput
with field(s):items(Vec::<AccessLogSubscriptionSummary>)
:Information about the access log subscriptions.
next_token(Option<String>)
:A pagination token for the next page of results.
- On failure, responds with
SdkError<ListAccessLogSubscriptionsError>
Source§impl Client
impl Client
Sourcepub fn list_listeners(&self) -> ListListenersFluentBuilder
pub fn list_listeners(&self) -> ListListenersFluentBuilder
Constructs a fluent builder for the ListListeners
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
service_identifier(impl Into<String>)
/set_service_identifier(Option<String>)
:
required: trueThe ID or ARN of the service.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA pagination token for the next page of results.
- On success, responds with
ListListenersOutput
with field(s):items(Vec::<ListenerSummary>)
:Information about the listeners.
next_token(Option<String>)
:If there are additional results, a pagination token for the next page of results.
- On failure, responds with
SdkError<ListListenersError>
Source§impl Client
impl Client
Sourcepub fn list_resource_configurations(
&self,
) -> ListResourceConfigurationsFluentBuilder
pub fn list_resource_configurations( &self, ) -> ListResourceConfigurationsFluentBuilder
Constructs a fluent builder for the ListResourceConfigurations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
resource_gateway_identifier(impl Into<String>)
/set_resource_gateway_identifier(Option<String>)
:
required: falseThe ID of the resource gateway for the resource configuration.
resource_configuration_group_identifier(impl Into<String>)
/set_resource_configuration_group_identifier(Option<String>)
:
required: falseThe ID of the group resource configuration.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum page size.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA pagination token for the next page of results.
- On success, responds with
ListResourceConfigurationsOutput
with field(s):items(Option<Vec::<ResourceConfigurationSummary>>)
:Information about the resource configurations.
next_token(Option<String>)
:If there are additional results, a pagination token for the next page of results.
- On failure, responds with
SdkError<ListResourceConfigurationsError>
Source§impl Client
impl Client
Sourcepub fn list_resource_endpoint_associations(
&self,
) -> ListResourceEndpointAssociationsFluentBuilder
pub fn list_resource_endpoint_associations( &self, ) -> ListResourceEndpointAssociationsFluentBuilder
Constructs a fluent builder for the ListResourceEndpointAssociations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
resource_configuration_identifier(impl Into<String>)
/set_resource_configuration_identifier(Option<String>)
:
required: trueThe ID for the resource configuration associated with the VPC endpoint.
resource_endpoint_association_identifier(impl Into<String>)
/set_resource_endpoint_association_identifier(Option<String>)
:
required: falseThe ID of the association.
vpc_endpoint_id(impl Into<String>)
/set_vpc_endpoint_id(Option<String>)
:
required: falseThe ID of the VPC endpoint in the association.
vpc_endpoint_owner(impl Into<String>)
/set_vpc_endpoint_owner(Option<String>)
:
required: falseThe owner of the VPC endpoint in the association.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum page size.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA pagination token for the next page of results.
- On success, responds with
ListResourceEndpointAssociationsOutput
with field(s):items(Vec::<ResourceEndpointAssociationSummary>)
:Information about the VPC endpoint associations.
next_token(Option<String>)
:If there are additional results, a pagination token for the next page of results.
- On failure, responds with
SdkError<ListResourceEndpointAssociationsError>
Source§impl Client
impl Client
Sourcepub fn list_resource_gateways(&self) -> ListResourceGatewaysFluentBuilder
pub fn list_resource_gateways(&self) -> ListResourceGatewaysFluentBuilder
Constructs a fluent builder for the ListResourceGateways
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum page size.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf there are additional results, a pagination token for the next page of results.
- On success, responds with
ListResourceGatewaysOutput
with field(s):items(Option<Vec::<ResourceGatewaySummary>>)
:Information about the resource gateways.
next_token(Option<String>)
:If there are additional results, a pagination token for the next page of results.
- On failure, responds with
SdkError<ListResourceGatewaysError>
Source§impl Client
impl Client
Sourcepub fn list_rules(&self) -> ListRulesFluentBuilder
pub fn list_rules(&self) -> ListRulesFluentBuilder
Constructs a fluent builder for the ListRules
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
service_identifier(impl Into<String>)
/set_service_identifier(Option<String>)
:
required: trueThe ID or ARN of the service.
listener_identifier(impl Into<String>)
/set_listener_identifier(Option<String>)
:
required: trueThe ID or ARN of the listener.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA pagination token for the next page of results.
- On success, responds with
ListRulesOutput
with field(s):items(Vec::<RuleSummary>)
:Information about the rules.
next_token(Option<String>)
:If there are additional results, a pagination token for the next page of results.
- On failure, responds with
SdkError<ListRulesError>
Source§impl Client
impl Client
Sourcepub fn list_service_network_resource_associations(
&self,
) -> ListServiceNetworkResourceAssociationsFluentBuilder
pub fn list_service_network_resource_associations( &self, ) -> ListServiceNetworkResourceAssociationsFluentBuilder
Constructs a fluent builder for the ListServiceNetworkResourceAssociations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
service_network_identifier(impl Into<String>)
/set_service_network_identifier(Option<String>)
:
required: falseThe ID of the service network.
resource_configuration_identifier(impl Into<String>)
/set_resource_configuration_identifier(Option<String>)
:
required: falseThe ID of the resource configurationk.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum page size.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf there are additional results, a pagination token for the next page of results.
- On success, responds with
ListServiceNetworkResourceAssociationsOutput
with field(s):items(Vec::<ServiceNetworkResourceAssociationSummary>)
:Information about the associations.
next_token(Option<String>)
:If there are additional results, a pagination token for the next page of results.
- On failure, responds with
SdkError<ListServiceNetworkResourceAssociationsError>
Source§impl Client
impl Client
Sourcepub fn list_service_network_service_associations(
&self,
) -> ListServiceNetworkServiceAssociationsFluentBuilder
pub fn list_service_network_service_associations( &self, ) -> ListServiceNetworkServiceAssociationsFluentBuilder
Constructs a fluent builder for the ListServiceNetworkServiceAssociations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
service_network_identifier(impl Into<String>)
/set_service_network_identifier(Option<String>)
:
required: falseThe ID or ARN of the service network.
service_identifier(impl Into<String>)
/set_service_identifier(Option<String>)
:
required: falseThe ID or ARN of the service.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA pagination token for the next page of results.
- On success, responds with
ListServiceNetworkServiceAssociationsOutput
with field(s):items(Vec::<ServiceNetworkServiceAssociationSummary>)
:Information about the associations.
next_token(Option<String>)
:If there are additional results, a pagination token for the next page of results.
- On failure, responds with
SdkError<ListServiceNetworkServiceAssociationsError>
Source§impl Client
impl Client
Sourcepub fn list_service_network_vpc_associations(
&self,
) -> ListServiceNetworkVpcAssociationsFluentBuilder
pub fn list_service_network_vpc_associations( &self, ) -> ListServiceNetworkVpcAssociationsFluentBuilder
Constructs a fluent builder for the ListServiceNetworkVpcAssociations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
service_network_identifier(impl Into<String>)
/set_service_network_identifier(Option<String>)
:
required: falseThe ID or ARN of the service network.
vpc_identifier(impl Into<String>)
/set_vpc_identifier(Option<String>)
:
required: falseThe ID or ARN of the VPC.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA pagination token for the next page of results.
- On success, responds with
ListServiceNetworkVpcAssociationsOutput
with field(s):items(Vec::<ServiceNetworkVpcAssociationSummary>)
:Information about the associations.
next_token(Option<String>)
:If there are additional results, a pagination token for the next page of results.
- On failure, responds with
SdkError<ListServiceNetworkVpcAssociationsError>
Source§impl Client
impl Client
Sourcepub fn list_service_network_vpc_endpoint_associations(
&self,
) -> ListServiceNetworkVpcEndpointAssociationsFluentBuilder
pub fn list_service_network_vpc_endpoint_associations( &self, ) -> ListServiceNetworkVpcEndpointAssociationsFluentBuilder
Constructs a fluent builder for the ListServiceNetworkVpcEndpointAssociations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
service_network_identifier(impl Into<String>)
/set_service_network_identifier(Option<String>)
:
required: trueThe ID of the service network associated with the VPC endpoint.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum page size.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf there are additional results, a pagination token for the next page of results.
- On success, responds with
ListServiceNetworkVpcEndpointAssociationsOutput
with field(s):items(Vec::<ServiceNetworkEndpointAssociation>)
:Information about the association between the VPC endpoint and service network.
next_token(Option<String>)
:If there are additional results, a pagination token for the next page of results.
- On failure, responds with
SdkError<ListServiceNetworkVpcEndpointAssociationsError>
Source§impl Client
impl Client
Sourcepub fn list_service_networks(&self) -> ListServiceNetworksFluentBuilder
pub fn list_service_networks(&self) -> ListServiceNetworksFluentBuilder
Constructs a fluent builder for the ListServiceNetworks
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA pagination token for the next page of results.
- On success, responds with
ListServiceNetworksOutput
with field(s):items(Vec::<ServiceNetworkSummary>)
:Information about the service networks.
next_token(Option<String>)
:If there are additional results, a pagination token for the next page of results.
- On failure, responds with
SdkError<ListServiceNetworksError>
Source§impl Client
impl Client
Sourcepub fn list_services(&self) -> ListServicesFluentBuilder
pub fn list_services(&self) -> ListServicesFluentBuilder
Constructs a fluent builder for the ListServices
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA pagination token for the next page of results.
- On success, responds with
ListServicesOutput
with field(s):items(Option<Vec::<ServiceSummary>>)
:Information about the services.
next_token(Option<String>)
:If there are additional results, a pagination token for the next page of results.
- On failure, responds with
SdkError<ListServicesError>
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 Amazon Resource Name (ARN) of the resource.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<HashMap::<String, String>>)
:Information about the tags.
- On failure, responds with
SdkError<ListTagsForResourceError>
Source§impl Client
impl Client
Sourcepub fn list_target_groups(&self) -> ListTargetGroupsFluentBuilder
pub fn list_target_groups(&self) -> ListTargetGroupsFluentBuilder
Constructs a fluent builder for the ListTargetGroups
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA pagination token for the next page of results.
vpc_identifier(impl Into<String>)
/set_vpc_identifier(Option<String>)
:
required: falseThe ID or ARN of the VPC.
target_group_type(TargetGroupType)
/set_target_group_type(Option<TargetGroupType>)
:
required: falseThe target group type.
- On success, responds with
ListTargetGroupsOutput
with field(s):items(Option<Vec::<TargetGroupSummary>>)
:Information about the target groups.
next_token(Option<String>)
:If there are additional results, a pagination token for the next page of results.
- On failure, responds with
SdkError<ListTargetGroupsError>
Source§impl Client
impl Client
Sourcepub fn list_targets(&self) -> ListTargetsFluentBuilder
pub fn list_targets(&self) -> ListTargetsFluentBuilder
Constructs a fluent builder for the ListTargets
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
target_group_identifier(impl Into<String>)
/set_target_group_identifier(Option<String>)
:
required: trueThe ID or ARN of the target group.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA pagination token for the next page of results.
targets(Target)
/set_targets(Option<Vec::<Target>>)
:
required: falseThe targets.
- On success, responds with
ListTargetsOutput
with field(s):items(Vec::<TargetSummary>)
:Information about the targets.
next_token(Option<String>)
:If there are additional results, a pagination token for the next page of results.
- On failure, responds with
SdkError<ListTargetsError>
Source§impl Client
impl Client
Sourcepub fn put_auth_policy(&self) -> PutAuthPolicyFluentBuilder
pub fn put_auth_policy(&self) -> PutAuthPolicyFluentBuilder
Constructs a fluent builder for the PutAuthPolicy
operation.
- The fluent builder is configurable:
resource_identifier(impl Into<String>)
/set_resource_identifier(Option<String>)
:
required: trueThe ID or ARN of the service network or service for which the policy is created.
policy(impl Into<String>)
/set_policy(Option<String>)
:
required: trueThe auth policy. The policy string in JSON must not contain newlines or blank lines.
- On success, responds with
PutAuthPolicyOutput
with field(s):policy(Option<String>)
:The auth policy. The policy string in JSON must not contain newlines or blank lines.
state(Option<AuthPolicyState>)
:The state of the auth policy. The auth policy is only active when the auth type is set to
AWS_IAM
. If you provide a policy, then authentication and authorization decisions are made based on this policy and the client’s IAM policy. If the Auth type isNONE
, then, any auth policy that you provide remains inactive. For more information, see Create a service network in the Amazon VPC Lattice User Guide.
- On failure, responds with
SdkError<PutAuthPolicyError>
Source§impl Client
impl Client
Sourcepub fn put_resource_policy(&self) -> PutResourcePolicyFluentBuilder
pub fn put_resource_policy(&self) -> PutResourcePolicyFluentBuilder
Constructs a fluent builder for the PutResourcePolicy
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe ID or ARN of the service network or service for which the policy is created.
policy(impl Into<String>)
/set_policy(Option<String>)
:
required: trueAn IAM policy. The policy string in JSON must not contain newlines or blank lines.
- On success, responds with
PutResourcePolicyOutput
- On failure, responds with
SdkError<PutResourcePolicyError>
Source§impl Client
impl Client
Sourcepub fn register_targets(&self) -> RegisterTargetsFluentBuilder
pub fn register_targets(&self) -> RegisterTargetsFluentBuilder
Constructs a fluent builder for the RegisterTargets
operation.
- The fluent builder is configurable:
target_group_identifier(impl Into<String>)
/set_target_group_identifier(Option<String>)
:
required: trueThe ID or ARN of the target group.
targets(Target)
/set_targets(Option<Vec::<Target>>)
:
required: trueThe targets.
- On success, responds with
RegisterTargetsOutput
with field(s):successful(Option<Vec::<Target>>)
:The targets that were successfully registered.
unsuccessful(Option<Vec::<TargetFailure>>)
:The targets that were not registered.
- On failure, responds with
SdkError<RegisterTargetsError>
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 Amazon Resource Name (ARN) of the resource.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: trueThe tags for the resource.
- 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 Amazon Resource Name (ARN) of the resource.
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueThe tag keys of the tags to remove.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
Source§impl Client
impl Client
Sourcepub fn update_access_log_subscription(
&self,
) -> UpdateAccessLogSubscriptionFluentBuilder
pub fn update_access_log_subscription( &self, ) -> UpdateAccessLogSubscriptionFluentBuilder
Constructs a fluent builder for the UpdateAccessLogSubscription
operation.
- The fluent builder is configurable:
access_log_subscription_identifier(impl Into<String>)
/set_access_log_subscription_identifier(Option<String>)
:
required: trueThe ID or ARN of the access log subscription.
destination_arn(impl Into<String>)
/set_destination_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the access log destination.
- On success, responds with
UpdateAccessLogSubscriptionOutput
with field(s):id(String)
:The ID of the access log subscription.
arn(String)
:The Amazon Resource Name (ARN) of the access log subscription.
resource_id(String)
:The ID of the resource.
resource_arn(String)
:The Amazon Resource Name (ARN) of the access log subscription.
destination_arn(String)
:The Amazon Resource Name (ARN) of the access log destination.
- On failure, responds with
SdkError<UpdateAccessLogSubscriptionError>
Source§impl Client
impl Client
Sourcepub fn update_listener(&self) -> UpdateListenerFluentBuilder
pub fn update_listener(&self) -> UpdateListenerFluentBuilder
Constructs a fluent builder for the UpdateListener
operation.
- The fluent builder is configurable:
service_identifier(impl Into<String>)
/set_service_identifier(Option<String>)
:
required: trueThe ID or ARN of the service.
listener_identifier(impl Into<String>)
/set_listener_identifier(Option<String>)
:
required: trueThe ID or ARN of the listener.
default_action(RuleAction)
/set_default_action(Option<RuleAction>)
:
required: trueThe action for the default rule.
- On success, responds with
UpdateListenerOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name (ARN) of the listener.
id(Option<String>)
:The ID of the listener.
name(Option<String>)
:The name of the listener.
protocol(Option<ListenerProtocol>)
:The protocol of the listener.
port(Option<i32>)
:The listener port.
service_arn(Option<String>)
:The Amazon Resource Name (ARN) of the service.
service_id(Option<String>)
:The ID of the service.
default_action(Option<RuleAction>)
:The action for the default rule.
- On failure, responds with
SdkError<UpdateListenerError>
Source§impl Client
impl Client
Sourcepub fn update_resource_configuration(
&self,
) -> UpdateResourceConfigurationFluentBuilder
pub fn update_resource_configuration( &self, ) -> UpdateResourceConfigurationFluentBuilder
Constructs a fluent builder for the UpdateResourceConfiguration
operation.
- The fluent builder is configurable:
resource_configuration_identifier(impl Into<String>)
/set_resource_configuration_identifier(Option<String>)
:
required: trueThe ID of the resource configuration.
resource_configuration_definition(ResourceConfigurationDefinition)
/set_resource_configuration_definition(Option<ResourceConfigurationDefinition>)
:
required: falseThe resource configuration.
allow_association_to_shareable_service_network(bool)
/set_allow_association_to_shareable_service_network(Option<bool>)
:
required: falseIndicates whether to add the resource configuration to service networks that are shared with other accounts.
port_ranges(impl Into<String>)
/set_port_ranges(Option<Vec::<String>>)
:
required: falseThe TCP port ranges that a consumer can use to access a resource configuration. You can separate port ranges with a comma. Example: 1-65535 or 1,2,22-30
- On success, responds with
UpdateResourceConfigurationOutput
with field(s):id(Option<String>)
:The ID of the resource configuration.
name(Option<String>)
:The name of the resource configuration.
arn(Option<String>)
:The Amazon Resource Name (ARN) of the resource configuration.
resource_gateway_id(Option<String>)
:The ID of the resource gateway associated with the resource configuration.
resource_configuration_group_id(Option<String>)
:The ID of the group resource configuration.
r#type(Option<ResourceConfigurationType>)
:The type of resource configuration.
-
SINGLE
- A single resource. -
GROUP
- A group of resources. -
CHILD
- A single resource that is part of a group resource configuration. -
ARN
- An Amazon Web Services resource.
-
port_ranges(Option<Vec::<String>>)
:The TCP port ranges that a consumer can use to access a resource configuration. You can separate port ranges with a comma. Example: 1-65535 or 1,2,22-30
allow_association_to_shareable_service_network(Option<bool>)
:Indicates whether to add the resource configuration to service networks that are shared with other accounts.
protocol(Option<ProtocolType>)
:The TCP protocol accepted by the specified resource configuration.
status(Option<ResourceConfigurationStatus>)
:The status of the resource configuration.
resource_configuration_definition(Option<ResourceConfigurationDefinition>)
:The resource configuration.
- On failure, responds with
SdkError<UpdateResourceConfigurationError>
Source§impl Client
impl Client
Sourcepub fn update_resource_gateway(&self) -> UpdateResourceGatewayFluentBuilder
pub fn update_resource_gateway(&self) -> UpdateResourceGatewayFluentBuilder
Constructs a fluent builder for the UpdateResourceGateway
operation.
- The fluent builder is configurable:
resource_gateway_identifier(impl Into<String>)
/set_resource_gateway_identifier(Option<String>)
:
required: trueThe ID or ARN of the resource gateway.
security_group_ids(impl Into<String>)
/set_security_group_ids(Option<Vec::<String>>)
:
required: falseThe IDs of the security groups associated with the resource gateway.
- On success, responds with
UpdateResourceGatewayOutput
with field(s):name(Option<String>)
:The name of the resource gateway.
id(Option<String>)
:The ID of the resource gateway.
arn(Option<String>)
:The Amazon Resource Name (ARN) of the resource gateway.
status(Option<ResourceGatewayStatus>)
:The status of the resource gateway.
vpc_id(Option<String>)
:The ID of the VPC for the resource gateway.
subnet_ids(Option<Vec::<String>>)
:The IDs of the VPC subnets for the resource gateway.
security_group_ids(Option<Vec::<String>>)
:The IDs of the security groups associated with the resource gateway.
ip_address_type(Option<IpAddressType>)
:The type of IP address used by the resource gateway.
- On failure, responds with
SdkError<UpdateResourceGatewayError>
Source§impl Client
impl Client
Sourcepub fn update_rule(&self) -> UpdateRuleFluentBuilder
pub fn update_rule(&self) -> UpdateRuleFluentBuilder
Constructs a fluent builder for the UpdateRule
operation.
- The fluent builder is configurable:
service_identifier(impl Into<String>)
/set_service_identifier(Option<String>)
:
required: trueThe ID or ARN of the service.
listener_identifier(impl Into<String>)
/set_listener_identifier(Option<String>)
:
required: trueThe ID or ARN of the listener.
rule_identifier(impl Into<String>)
/set_rule_identifier(Option<String>)
:
required: trueThe ID or ARN of the rule.
r#match(RuleMatch)
/set_match(Option<RuleMatch>)
:
required: falseThe rule match.
priority(i32)
/set_priority(Option<i32>)
:
required: falseThe rule priority. A listener can’t have multiple rules with the same priority.
action(RuleAction)
/set_action(Option<RuleAction>)
:
required: falseInformation about the action for the specified listener rule.
- On success, responds with
UpdateRuleOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name (ARN) of the listener.
id(Option<String>)
:The ID of the listener.
name(Option<String>)
:The name of the listener.
is_default(Option<bool>)
:Indicates whether this is the default rule.
r#match(Option<RuleMatch>)
:The rule match.
priority(Option<i32>)
:The rule priority.
action(Option<RuleAction>)
:Information about the action for the specified listener rule.
- On failure, responds with
SdkError<UpdateRuleError>
Source§impl Client
impl Client
Sourcepub fn update_service(&self) -> UpdateServiceFluentBuilder
pub fn update_service(&self) -> UpdateServiceFluentBuilder
Constructs a fluent builder for the UpdateService
operation.
- The fluent builder is configurable:
service_identifier(impl Into<String>)
/set_service_identifier(Option<String>)
:
required: trueThe ID or ARN of the service.
certificate_arn(impl Into<String>)
/set_certificate_arn(Option<String>)
:
required: falseThe Amazon Resource Name (ARN) of the certificate.
auth_type(AuthType)
/set_auth_type(Option<AuthType>)
:
required: falseThe type of IAM policy.
-
NONE
: The resource does not use an IAM policy. This is the default. -
AWS_IAM
: The resource uses an IAM policy. When this type is used, auth is enabled and an auth policy is required.
-
- On success, responds with
UpdateServiceOutput
with field(s):id(Option<String>)
:The ID of the service.
arn(Option<String>)
:The Amazon Resource Name (ARN) of the service.
name(Option<String>)
:The name of the service.
custom_domain_name(Option<String>)
:The custom domain name of the service.
certificate_arn(Option<String>)
:The Amazon Resource Name (ARN) of the certificate.
auth_type(Option<AuthType>)
:The type of IAM policy.
- On failure, responds with
SdkError<UpdateServiceError>
Source§impl Client
impl Client
Sourcepub fn update_service_network(&self) -> UpdateServiceNetworkFluentBuilder
pub fn update_service_network(&self) -> UpdateServiceNetworkFluentBuilder
Constructs a fluent builder for the UpdateServiceNetwork
operation.
- The fluent builder is configurable:
service_network_identifier(impl Into<String>)
/set_service_network_identifier(Option<String>)
:
required: trueThe ID or ARN of the service network.
auth_type(AuthType)
/set_auth_type(Option<AuthType>)
:
required: trueThe type of IAM policy.
-
NONE
: The resource does not use an IAM policy. This is the default. -
AWS_IAM
: The resource uses an IAM policy. When this type is used, auth is enabled and an auth policy is required.
-
- On success, responds with
UpdateServiceNetworkOutput
with field(s):id(Option<String>)
:The ID of the service network.
name(Option<String>)
:The name of the service network.
arn(Option<String>)
:The Amazon Resource Name (ARN) of the service network.
auth_type(Option<AuthType>)
:The type of IAM policy.
- On failure, responds with
SdkError<UpdateServiceNetworkError>
Source§impl Client
impl Client
Sourcepub fn update_service_network_vpc_association(
&self,
) -> UpdateServiceNetworkVpcAssociationFluentBuilder
pub fn update_service_network_vpc_association( &self, ) -> UpdateServiceNetworkVpcAssociationFluentBuilder
Constructs a fluent builder for the UpdateServiceNetworkVpcAssociation
operation.
- The fluent builder is configurable:
service_network_vpc_association_identifier(impl Into<String>)
/set_service_network_vpc_association_identifier(Option<String>)
:
required: trueThe ID or ARN of the association.
security_group_ids(impl Into<String>)
/set_security_group_ids(Option<Vec::<String>>)
:
required: trueThe IDs of the security groups.
- On success, responds with
UpdateServiceNetworkVpcAssociationOutput
with field(s):id(Option<String>)
:The ID of the association.
arn(Option<String>)
:The Amazon Resource Name (ARN) of the association.
status(Option<ServiceNetworkVpcAssociationStatus>)
:The status. You can retry the operation if the status is
DELETE_FAILED
. However, if you retry it while the status isDELETE_IN_PROGRESS
, there is no change in the status.created_by(Option<String>)
:The account that created the association.
security_group_ids(Option<Vec::<String>>)
:The IDs of the security groups.
- On failure, responds with
SdkError<UpdateServiceNetworkVpcAssociationError>
Source§impl Client
impl Client
Sourcepub fn update_target_group(&self) -> UpdateTargetGroupFluentBuilder
pub fn update_target_group(&self) -> UpdateTargetGroupFluentBuilder
Constructs a fluent builder for the UpdateTargetGroup
operation.
- The fluent builder is configurable:
target_group_identifier(impl Into<String>)
/set_target_group_identifier(Option<String>)
:
required: trueThe ID or ARN of the target group.
health_check(HealthCheckConfig)
/set_health_check(Option<HealthCheckConfig>)
:
required: trueThe health check configuration.
- On success, responds with
UpdateTargetGroupOutput
with field(s):id(Option<String>)
:The ID of the target group.
arn(Option<String>)
:The Amazon Resource Name (ARN) of the target group.
name(Option<String>)
:The name of the target group.
r#type(Option<TargetGroupType>)
:The target group type.
config(Option<TargetGroupConfig>)
:The target group configuration.
status(Option<TargetGroupStatus>)
:The status.
- On failure, responds with
SdkError<UpdateTargetGroupError>
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>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
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>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
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>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
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>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
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>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
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>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
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 underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
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);