aws_sdk_transfer/client/
create_profile.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateProfile`](crate::operation::create_profile::builders::CreateProfileFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`as2_id(impl Into<String>)`](crate::operation::create_profile::builders::CreateProfileFluentBuilder::as2_id) / [`set_as2_id(Option<String>)`](crate::operation::create_profile::builders::CreateProfileFluentBuilder::set_as2_id):<br>required: **true**<br><p>The <code>As2Id</code> is the <i>AS2-name</i>, as defined in the <a href="https://datatracker.ietf.org/doc/html/rfc4130">RFC 4130</a>. For inbound transfers, this is the <code>AS2-From</code> header for the AS2 messages sent from the partner. For outbound connectors, this is the <code>AS2-To</code> header for the AS2 messages sent to the partner using the <code>StartFileTransfer</code> API operation. This ID cannot include spaces.</p><br>
    ///   - [`profile_type(ProfileType)`](crate::operation::create_profile::builders::CreateProfileFluentBuilder::profile_type) / [`set_profile_type(Option<ProfileType>)`](crate::operation::create_profile::builders::CreateProfileFluentBuilder::set_profile_type):<br>required: **true**<br><p>Determines the type of profile to create:</p> <ul>  <li>   <p>Specify <code>LOCAL</code> to create a local profile. A local profile represents the AS2-enabled Transfer Family server organization or party.</p></li>  <li>   <p>Specify <code>PARTNER</code> to create a partner profile. A partner profile represents a remote organization, external to Transfer Family.</p></li> </ul><br>
    ///   - [`certificate_ids(impl Into<String>)`](crate::operation::create_profile::builders::CreateProfileFluentBuilder::certificate_ids) / [`set_certificate_ids(Option<Vec::<String>>)`](crate::operation::create_profile::builders::CreateProfileFluentBuilder::set_certificate_ids):<br>required: **false**<br><p>An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.</p><br>
    ///   - [`tags(Tag)`](crate::operation::create_profile::builders::CreateProfileFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_profile::builders::CreateProfileFluentBuilder::set_tags):<br>required: **false**<br><p>Key-value pairs that can be used to group and search for AS2 profiles.</p><br>
    /// - On success, responds with [`CreateProfileOutput`](crate::operation::create_profile::CreateProfileOutput) with field(s):
    ///   - [`profile_id(String)`](crate::operation::create_profile::CreateProfileOutput::profile_id): <p>The unique identifier for the AS2 profile, returned after the API call succeeds.</p>
    /// - On failure, responds with [`SdkError<CreateProfileError>`](crate::operation::create_profile::CreateProfileError)
    pub fn create_profile(&self) -> crate::operation::create_profile::builders::CreateProfileFluentBuilder {
        crate::operation::create_profile::builders::CreateProfileFluentBuilder::new(self.handle.clone())
    }
}