Skip to main content

aws_sdk_devopsagent/client/
register_service.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`RegisterService`](crate::operation::register_service::builders::RegisterServiceFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`service(PostRegisterServiceSupportedService)`](crate::operation::register_service::builders::RegisterServiceFluentBuilder::service) / [`set_service(Option<PostRegisterServiceSupportedService>)`](crate::operation::register_service::builders::RegisterServiceFluentBuilder::set_service):<br>required: **true**<br>Services that can be registered via the post-registration API (excludes OAuth 3LO services).<br>
7    ///   - [`service_details(ServiceDetails)`](crate::operation::register_service::builders::RegisterServiceFluentBuilder::service_details) / [`set_service_details(Option<ServiceDetails>)`](crate::operation::register_service::builders::RegisterServiceFluentBuilder::set_service_details):<br>required: **true**<br>Service-specific authorization configuration parameters<br>
8    ///   - [`kms_key_arn(impl Into<String>)`](crate::operation::register_service::builders::RegisterServiceFluentBuilder::kms_key_arn) / [`set_kms_key_arn(Option<String>)`](crate::operation::register_service::builders::RegisterServiceFluentBuilder::set_kms_key_arn):<br>required: **false**<br>The ARN of the AWS Key Management Service (AWS KMS) customer managed key that's used to encrypt resources.<br>
9    ///   - [`private_connection_name(impl Into<String>)`](crate::operation::register_service::builders::RegisterServiceFluentBuilder::private_connection_name) / [`set_private_connection_name(Option<String>)`](crate::operation::register_service::builders::RegisterServiceFluentBuilder::set_private_connection_name):<br>required: **false**<br>The name of the private connection to use for VPC connectivity.<br>
10    ///   - [`name(impl Into<String>)`](crate::operation::register_service::builders::RegisterServiceFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::register_service::builders::RegisterServiceFluentBuilder::set_name):<br>required: **false**<br>The display name for the service registration.<br>
11    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::register_service::builders::RegisterServiceFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::register_service::builders::RegisterServiceFluentBuilder::set_tags):<br>required: **false**<br>Tags to add to the Service at registration time.<br>
12    /// - On success, responds with [`RegisterServiceOutput`](crate::operation::register_service::RegisterServiceOutput) with field(s):
13    ///   - [`service_id(Option<String>)`](crate::operation::register_service::RegisterServiceOutput::service_id): Service ID - present when registration is complete, absent when additional steps are required
14    ///   - [`additional_step(Option<AdditionalServiceRegistrationStep>)`](crate::operation::register_service::RegisterServiceOutput::additional_step): Indicates if additional steps are required to complete service registration (e.g., 3-legged OAuth)
15    ///   - [`kms_key_arn(Option<String>)`](crate::operation::register_service::RegisterServiceOutput::kms_key_arn): The ARN of the AWS Key Management Service (AWS KMS) customer managed key that's used to encrypt resources.
16    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::register_service::RegisterServiceOutput::tags): Tags associated with the registered Service.
17    /// - On failure, responds with [`SdkError<RegisterServiceError>`](crate::operation::register_service::RegisterServiceError)
18    pub fn register_service(&self) -> crate::operation::register_service::builders::RegisterServiceFluentBuilder {
19        crate::operation::register_service::builders::RegisterServiceFluentBuilder::new(self.handle.clone())
20    }
21}