create_location_smb async ¶

async def create_location_smb(
    self,
    subdirectory: "capo_datasync.types.smb_subdirectory.SmbSubdirectory",
    server_hostname: "capo_datasync.types.server_hostname.ServerHostname",
    agent_arns: "capo_datasync.types.agent_arn_list.AgentArnList",
    *,
    config_overrides: Optional[AsyncDataSyncClientConfig] = None,
    user: Optional["capo_datasync.types.smb_user.SmbUser"] = None,
    domain: Optional["capo_datasync.types.smb_domain.SmbDomain"] = None,
    password: Optional["capo_datasync.types.smb_password.SmbPassword"] = None,
    cmk_secret_config: Optional[
        "capo_datasync.types.cmk_secret_config.CmkSecretConfig"
    ] = None,
    custom_secret_config: Optional[
        "capo_datasync.types.custom_secret_config.CustomSecretConfig"
    ] = None,
    mount_options: Optional[
        "capo_datasync.types.smb_mount_options.SmbMountOptions"
    ] = None,
    tags: Optional["capo_datasync.types.input_tag_list.InputTagList"] = None,
    authentication_type: Optional[
        "capo_datasync.types.smb_authentication_type.SmbAuthenticationType"
    ] = None,
    dns_ip_addresses: Optional["capo_datasync.types.dns_ip_list.DnsIpList"] = None,
    kerberos_principal: Optional[
        "capo_datasync.types.kerberos_principal.KerberosPrincipal"
    ] = None,
    kerberos_keytab: Optional[
        "capo_datasync.types.kerberos_keytab_file.KerberosKeytabFile"
    ] = None,
    kerberos_krb5_conf: Optional[
        "capo_datasync.types.kerberos_krb5_conf_file.KerberosKrb5ConfFile"
    ] = None,
) -> "capo_datasync.types.create_location_smb_response.CreateLocationSmbResponse":
    """<p>Creates a transfer <i>location</i> for a Server Message Block (SMB) file server. DataSync can use this location as a source or destination for transferring data.</p> <p>Before you begin, make sure that you understand how DataSync accesses SMB file servers. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions">Providing DataSync access to SMB file servers</a>.</p>

    Args:
        subdirectory: <p>Specifies the name of the share exported by your SMB file server where DataSync will read or write data. You can include a subdirectory in the share path (for example, <code>/path/to/subdirectory</code>). Make sure that other SMB clients in your network can also mount this path.</p> <p>To copy all data in the subdirectory, DataSync must be able to mount the SMB share and access all of its data. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions">Providing DataSync access to SMB file servers</a>.</p>
        server_hostname: <p>Specifies the domain name or IP address (IPv4 or IPv6) of the SMB file server that your DataSync agent connects to.</p> <note> <p>If you're using Kerberos authentication, you must specify a domain name.</p> </note>
        user: <p>Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server. This parameter applies only if <code>AuthenticationType</code> is set to <code>NTLM</code>.</p> <p>For information about choosing a user with the right level of access for your transfer, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions">Providing DataSync access to SMB file servers</a>.</p>
        domain: <p>Specifies the Windows domain name that your SMB file server belongs to. This parameter applies only if <code>AuthenticationType</code> is set to <code>NTLM</code>.</p> <p>If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.</p>
        password: <p>Specifies the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer. This parameter applies only if <code>AuthenticationType</code> is set to <code>NTLM</code>.</p>
        cmk_secret_config: <p>Specifies configuration information for a DataSync-managed secret, either a <code>Password</code> or <code>KerberosKeytab</code> (for <code>NTLM</code> (default) and <code>KERBEROS</code> authentication types, respectively) that DataSync uses to access a specific SMB storage location, with a customer-managed KMS key.</p> <p>When you include this parameter as part of a <code>CreateLocationSmbRequest</code> request, you provide only the KMS key ARN. DataSync uses this KMS key together with either the <code>Password</code> or <code>KerberosKeytab</code> you specify to create a DataSync-managed secret to store the location access credentials.</p> <p>Make sure that DataSync has permission to access the KMS key that you specify. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#service-secret-custom-key"> Using a service-managed secret encrypted with a custom KMS key</a>.</p> <note> <p>You can use either <code>CmkSecretConfig</code> (with either <code>Password</code> or <code>KerberosKeytab</code>) or <code>CustomSecretConfig</code> (without any <code>Password</code> and <code>KerberosKeytab</code>) to provide credentials for a <code>CreateLocationSmbRequest</code> request. Do not provide both <code>CmkSecretConfig</code> and <code>CustomSecretConfig</code> parameters for the same request.</p> </note>
        custom_secret_config: <p>Specifies configuration information for a customer-managed Secrets Manager secret where the SMB storage location credentials is stored in Secrets Manager as plain text (for <code>Password</code>) or binary (for <code>KerberosKeytab</code>). This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#custom-secret-custom-key"> Using a secret that you manage</a>.</p> <note> <p>You can use either <code>CmkSecretConfig</code> (with <code>SasConfiguration</code>) or <code>CustomSecretConfig</code> (without <code>SasConfiguration</code>) to provide credentials for a <code>CreateLocationSmbRequest</code> request. Do not provide both parameters for the same request.</p> </note>
        agent_arns: <p>Specifies the DataSync agent (or agents) that can connect to your SMB file server. You specify an agent by using its Amazon Resource Name (ARN).</p>
        mount_options: <p>Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.</p>
        tags: <p>Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.</p>
        authentication_type: <p>Specifies the authentication protocol that DataSync uses to connect to your SMB file server. DataSync supports <code>NTLM</code> (default) and <code>KERBEROS</code> authentication.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions">Providing DataSync access to SMB file servers</a>.</p>
        dns_ip_addresses: <p>Specifies the IPv4 or IPv6 addresses for the DNS servers that your SMB file server belongs to. This parameter applies only if <code>AuthenticationType</code> is set to <code>KERBEROS</code>.</p> <p>If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right SMB file server.</p>
        kerberos_principal: <p>Specifies a Kerberos principal, which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server.</p> <p>A Kerberos principal might look like <code>HOST/[email protected]</code>.</p> <p>Principal names are case sensitive. Your DataSync task execution will fail if the principal that you specify for this parameter doesn’t exactly match the principal that you use to create the keytab file.</p>
        kerberos_keytab: <p>Specifies your Kerberos key table (keytab) file, which includes mappings between your Kerberos principal and encryption keys.</p> <p>To avoid task execution errors, make sure that the Kerberos principal that you use to create the keytab file matches exactly what you specify for <code>KerberosPrincipal</code>. </p>
        kerberos_krb5_conf: <p>Specifies a Kerberos configuration file (<code>krb5.conf</code>) that defines your Kerberos realm configuration.</p> <p>The file must be base64 encoded. If you're using the CLI, the encoding is done for you.</p>

    Raises:
        capo_datasync.errors.internal_exception.InternalException: <p>This exception is thrown when an error occurs in the DataSync service.</p>
        capo_datasync.errors.invalid_request_exception.InvalidRequestException: <p>This exception is thrown when the client submits a malformed request.</p>
        capo_datasync.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_datasync.types.create_location_smb_request.CreateLocationSmbRequest]",
    ) -> AsyncOperationResponse[
        "capo_datasync.types.create_location_smb_response.CreateLocationSmbResponse"
    ]:
        import capo_datasync._operations.fmrs_service.create_location_smb

        (
            output,
            http_response,
        ) = await capo_datasync._operations.fmrs_service.create_location_smb.async_create_location_smb(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_datasync.types.create_location_smb_request.CreateLocationSmbRequest",
    ) -> dict[str, Any]:
        import capo_datasync.types.create_location_smb_request

        return capo_datasync.types.create_location_smb_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("CreateLocationSmb", redact_input=_redact_input),
    )
    input_: capo_datasync.types.create_location_smb_request.CreateLocationSmbRequest = {
        "subdirectory": subdirectory,
        "server_hostname": server_hostname,
        "agent_arns": agent_arns,
    }
    if user is not None:
        input_["user"] = user
    if domain is not None:
        input_["domain"] = domain
    if password is not None:
        input_["password"] = password
    if cmk_secret_config is not None:
        input_["cmk_secret_config"] = cmk_secret_config
    if custom_secret_config is not None:
        input_["custom_secret_config"] = custom_secret_config
    if mount_options is not None:
        input_["mount_options"] = mount_options
    if tags is not None:
        input_["tags"] = tags
    if authentication_type is not None:
        input_["authentication_type"] = authentication_type
    if dns_ip_addresses is not None:
        input_["dns_ip_addresses"] = dns_ip_addresses
    if kerberos_principal is not None:
        input_["kerberos_principal"] = kerberos_principal
    if kerberos_keytab is not None:
        input_["kerberos_keytab"] = kerberos_keytab
    if kerberos_krb5_conf is not None:
        input_["kerberos_krb5_conf"] = kerberos_krb5_conf

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output