AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Connect Service AssociateInstanceStorageConfig API operation.

Syntax

Add-CONNInstanceStorageConfig
-StorageConfig_AssociationId <String>
-S3Config_BucketName <String>
-S3Config_BucketPrefix <String>
-StorageConfigKinesisVideoStreamConfigEncryptionConfigEncryptionType <EncryptionType>
-StorageConfigS3ConfigEncryptionConfigEncryptionType <EncryptionType>
-KinesisFirehoseConfig_FirehoseArn <String>
-InstanceId <String>
-StorageConfigKinesisVideoStreamConfigEncryptionConfigKeyId <String>
-StorageConfigS3ConfigEncryptionConfigKeyId <String>
-KinesisVideoStreamConfig_Prefix <String>
-ResourceType <InstanceStorageResourceType>
-KinesisVideoStreamConfig_RetentionPeriodHour <Int32>
-StorageConfig_StorageType <StorageType>
-KinesisStreamConfig_StreamArn <String>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonConnectConfig>

Description

This API is in preview release for Amazon Connect and is subject to change. Associates a storage resource type for the first time. You can only associate one type of storage configuration in a single call. This means, for example, that you can't define an instance with multiple S3 buckets for storing chat transcripts. This API does not create a resource that doesn't exist. It only associates it to the instance. Ensure that the resource being specified in the storage configuration, like an S3 bucket, exists when being used for association.

Parameters

-ClientConfig <AmazonConnectConfig>
Amazon.PowerShell.Cmdlets.CONN.AmazonConnectClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InstanceId <String>
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-KinesisFirehoseConfig_FirehoseArn <String>
The Amazon Resource Name (ARN) of the delivery stream.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageConfig_KinesisFirehoseConfig_FirehoseArn
-KinesisStreamConfig_StreamArn <String>
The Amazon Resource Name (ARN) of the data stream.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageConfig_KinesisStreamConfig_StreamArn
-KinesisVideoStreamConfig_Prefix <String>
The prefix of the video stream.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageConfig_KinesisVideoStreamConfig_Prefix
-KinesisVideoStreamConfig_RetentionPeriodHour <Int32>
The number of hours data is retained in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.The default value is 0, indicating that the stream does not persist data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageConfig_KinesisVideoStreamConfig_RetentionPeriodHours
-ResourceType <InstanceStorageResourceType>
A valid resource type. To enable streaming for real-time analysis of contacts, use the following types:
  • For chat contacts, use REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS.
  • For voice contacts, use REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS.
REAL_TIME_CONTACT_ANALYSIS_SEGMENTS is deprecated, but it is still supported and will apply only to VOICE channel contacts. Use REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS for voice contacts moving forward.If you have previously associated a stream with REAL_TIME_CONTACT_ANALYSIS_SEGMENTS, no action is needed to update the stream to REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3Config_BucketName <String>
The S3 bucket name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageConfig_S3Config_BucketName
-S3Config_BucketPrefix <String>
The S3 bucket prefix.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageConfig_S3Config_BucketPrefix
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'AssociationId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.AssociateInstanceStorageConfigResponse). Specifying the name of a property of type Amazon.Connect.Model.AssociateInstanceStorageConfigResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageConfig_AssociationId <String>
The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageConfig_StorageType <StorageType>
A valid storage type.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageConfigKinesisVideoStreamConfigEncryptionConfigEncryptionType <EncryptionType>
The type of encryption.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageConfig_KinesisVideoStreamConfig_EncryptionConfig_EncryptionType
-StorageConfigKinesisVideoStreamConfigEncryptionConfigKeyId <String>
The full ARN of the encryption key. Be sure to provide the full ARN of the encryption key, not just the ID.Amazon Connect supports only KMS keys with the default key spec of SYMMETRIC_DEFAULT.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageConfig_KinesisVideoStreamConfig_EncryptionConfig_KeyId
-StorageConfigS3ConfigEncryptionConfigEncryptionType <EncryptionType>
The type of encryption.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageConfig_S3Config_EncryptionConfig_EncryptionType
-StorageConfigS3ConfigEncryptionConfigKeyId <String>
The full ARN of the encryption key. Be sure to provide the full ARN of the encryption key, not just the ID.Amazon Connect supports only KMS keys with the default key spec of SYMMETRIC_DEFAULT.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageConfig_S3Config_EncryptionConfig_KeyId

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

System.String or Amazon.Connect.Model.AssociateInstanceStorageConfigResponse
This cmdlet returns a System.String object. The service call response (type Amazon.Connect.Model.AssociateInstanceStorageConfigResponse) can be returned by specifying '-Select *'.
Administrator Guide
User Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z