Struct aws_sdk_codestarconnections::Client
source · [−]pub struct Client { /* private fields */ }
Expand description
Client for AWS CodeStar connections
Client for invoking operations on AWS CodeStar connections. Each operation on AWS CodeStar connections is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
Examples
Constructing a client and invoking an operation
// create a shared configuration. This can be used & shared between multiple service clients.
let shared_config = aws_config::load_from_env().await;
let client = aws_sdk_codestarconnections::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */
Constructing a client with custom configuration
use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_codestarconnections::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_codestarconnections::Client::from_conf(config);
Implementations
sourceimpl Client
impl Client
sourcepub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
Creates a client with the given service configuration.
sourceimpl Client
impl Client
sourcepub fn create_connection(&self) -> CreateConnection
pub fn create_connection(&self) -> CreateConnection
Constructs a fluent builder for the CreateConnection
operation.
- The fluent builder is configurable:
provider_type(ProviderType)
/set_provider_type(Option<ProviderType>)
:The name of the external provider where your third-party code repository is configured.
connection_name(impl Into<String>)
/set_connection_name(Option<String>)
:The name of the connection to be created. The name must be unique in the calling AWS account.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The key-value pair to use when tagging the resource.
host_arn(impl Into<String>)
/set_host_arn(Option<String>)
:The Amazon Resource Name (ARN) of the host associated with the connection to be created.
- On success, responds with
CreateConnectionOutput
with field(s):connection_arn(Option<String>)
:The Amazon Resource Name (ARN) of the connection to be created. The ARN is used as the connection reference when the connection is shared between AWS services.
The ARN is never reused if the connection is deleted.
tags(Option<Vec<Tag>>)
:Specifies the tags applied to the resource.
- On failure, responds with
SdkError<CreateConnectionError>
sourcepub fn create_host(&self) -> CreateHost
pub fn create_host(&self) -> CreateHost
Constructs a fluent builder for the CreateHost
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of the host to be created. The name must be unique in the calling AWS account.
provider_type(ProviderType)
/set_provider_type(Option<ProviderType>)
:The name of the installed provider to be associated with your connection. The host resource represents the infrastructure where your provider type is installed. The valid provider type is GitHub Enterprise Server.
provider_endpoint(impl Into<String>)
/set_provider_endpoint(Option<String>)
:The endpoint of the infrastructure to be represented by the host after it is created.
vpc_configuration(VpcConfiguration)
/set_vpc_configuration(Option<VpcConfiguration>)
:The VPC configuration to be provisioned for the host. A VPC must be configured and the infrastructure to be represented by the host must already be connected to the VPC.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
: (undocumented)
- On success, responds with
CreateHostOutput
with field(s):host_arn(Option<String>)
:The Amazon Resource Name (ARN) of the host to be created.
tags(Option<Vec<Tag>>)
: (undocumented)
- On failure, responds with
SdkError<CreateHostError>
sourcepub fn delete_connection(&self) -> DeleteConnection
pub fn delete_connection(&self) -> DeleteConnection
Constructs a fluent builder for the DeleteConnection
operation.
- The fluent builder is configurable:
connection_arn(impl Into<String>)
/set_connection_arn(Option<String>)
:The Amazon Resource Name (ARN) of the connection to be deleted.
The ARN is never reused if the connection is deleted.
- On success, responds with
DeleteConnectionOutput
- On failure, responds with
SdkError<DeleteConnectionError>
sourcepub fn delete_host(&self) -> DeleteHost
pub fn delete_host(&self) -> DeleteHost
Constructs a fluent builder for the DeleteHost
operation.
- The fluent builder is configurable:
host_arn(impl Into<String>)
/set_host_arn(Option<String>)
:The Amazon Resource Name (ARN) of the host to be deleted.
- On success, responds with
DeleteHostOutput
- On failure, responds with
SdkError<DeleteHostError>
sourcepub fn get_connection(&self) -> GetConnection
pub fn get_connection(&self) -> GetConnection
Constructs a fluent builder for the GetConnection
operation.
- The fluent builder is configurable:
connection_arn(impl Into<String>)
/set_connection_arn(Option<String>)
:The Amazon Resource Name (ARN) of a connection.
- On success, responds with
GetConnectionOutput
with field(s):connection(Option<Connection>)
:The connection details, such as status, owner, and provider type.
- On failure, responds with
SdkError<GetConnectionError>
sourcepub fn get_host(&self) -> GetHost
pub fn get_host(&self) -> GetHost
Constructs a fluent builder for the GetHost
operation.
- The fluent builder is configurable:
host_arn(impl Into<String>)
/set_host_arn(Option<String>)
:The Amazon Resource Name (ARN) of the requested host.
- On success, responds with
GetHostOutput
with field(s):name(Option<String>)
:The name of the requested host.
status(Option<String>)
:The status of the requested host.
provider_type(Option<ProviderType>)
:The provider type of the requested host, such as GitHub Enterprise Server.
provider_endpoint(Option<String>)
:The endpoint of the infrastructure represented by the requested host.
vpc_configuration(Option<VpcConfiguration>)
:The VPC configuration of the requested host.
- On failure, responds with
SdkError<GetHostError>
sourcepub fn list_connections(&self) -> ListConnections
pub fn list_connections(&self) -> ListConnections
Constructs a fluent builder for the ListConnections
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
provider_type_filter(ProviderType)
/set_provider_type_filter(Option<ProviderType>)
:Filters the list of connections to those associated with a specified provider, such as Bitbucket.
host_arn_filter(impl Into<String>)
/set_host_arn_filter(Option<String>)
:Filters the list of connections to those associated with a specified host.
max_results(i32)
/set_max_results(i32)
:The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned
nextToken
value.next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token that was returned from the previous
ListConnections
call, which can be used to return the next set of connections in the list.
- On success, responds with
ListConnectionsOutput
with field(s):connections(Option<Vec<Connection>>)
:A list of connections and the details for each connection, such as status, owner, and provider type.
next_token(Option<String>)
:A token that can be used in the next
ListConnections
call. To view all items in the list, continue to call this operation with each subsequent token until no morenextToken
values are returned.
- On failure, responds with
SdkError<ListConnectionsError>
sourcepub fn list_hosts(&self) -> ListHosts
pub fn list_hosts(&self) -> ListHosts
Constructs a fluent builder for the ListHosts
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(i32)
:The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned
nextToken
value.next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token that was returned from the previous
ListHosts
call, which can be used to return the next set of hosts in the list.
- On success, responds with
ListHostsOutput
with field(s):hosts(Option<Vec<Host>>)
:A list of hosts and the details for each host, such as status, endpoint, and provider type.
next_token(Option<String>)
:A token that can be used in the next
ListHosts
call. To view all items in the list, continue to call this operation with each subsequent token until no morenextToken
values are returned.
- On failure, responds with
SdkError<ListHostsError>
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Name (ARN) of the resource for which you want to get information about tags, if any.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<Vec<Tag>>)
:A list of tag key and value pairs associated with the specified resource.
- On failure, responds with
SdkError<ListTagsForResourceError>
sourcepub fn tag_resource(&self) -> TagResource
pub fn tag_resource(&self) -> TagResource
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Name (ARN) of the resource to which you want to add or update tags.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The tags you want to modify or add to the resource.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
sourcepub fn untag_resource(&self) -> UntagResource
pub fn untag_resource(&self) -> UntagResource
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Name (ARN) of the resource to remove tags from.
tag_keys(Vec<String>)
/set_tag_keys(Option<Vec<String>>)
:The list of keys for the tags to be removed from the resource.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
sourcepub fn update_host(&self) -> UpdateHost
pub fn update_host(&self) -> UpdateHost
Constructs a fluent builder for the UpdateHost
operation.
- The fluent builder is configurable:
host_arn(impl Into<String>)
/set_host_arn(Option<String>)
:The Amazon Resource Name (ARN) of the host to be updated.
provider_endpoint(impl Into<String>)
/set_provider_endpoint(Option<String>)
:The URL or endpoint of the host to be updated.
vpc_configuration(VpcConfiguration)
/set_vpc_configuration(Option<VpcConfiguration>)
:The VPC configuration of the host to be updated. A VPC must be configured and the infrastructure to be represented by the host must already be connected to the VPC.
- On success, responds with
UpdateHostOutput
- On failure, responds with
SdkError<UpdateHostError>
sourceimpl Client
impl Client
sourcepub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
pub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
Creates a client with the given service config and connector override.
Trait Implementations
sourceimpl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
sourcefn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
Performs the conversion.
Auto Trait Implementations
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more