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 Cases CreateRelatedItem API operation.

Syntax

New-CCASRelatedItem
-DomainId <String>
-Comment_Body <String>
-CaseId <String>
-ConnectCase_CaseId <String>
-Contact_ContactArn <String>
-Comment_ContentType <CommentBodyTextType>
-PerformedBy_CustomEntity <String>
-SlaInputConfiguration_FieldId <String>
-Custom_Field <FieldValue[]>
-File_FileArn <String>
-SlaInputConfiguration_Name <String>
-SlaInputConfiguration_TargetFieldValue <FieldValueUnion[]>
-SlaInputConfiguration_TargetSlaMinute <Int64>
-SlaInputConfiguration_Type <SlaType>
-Type <RelatedItemType>
-PerformedBy_UserArn <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonConnectCasesConfig>

Description

Creates a related item (comments, tasks, and contacts) and associates it with a case. There's a quota for the number of fields allowed in a Custom type related item. See Amazon Connect Cases quotas. Use cases Following are examples of related items that you may want to associate with a case:
  • Related contacts, such as calls, chats, emails tasks
  • Comments, for agent notes
  • SLAs, to capture target resolution goals
  • Cases, to capture related Amazon Connect Cases
  • Files, such as policy documentation or customer-provided attachments
  • Custom related items, which provide flexibility for you to define related items that such as bookings, orders, products, notices, and more
Important things to know
  • If you are associating a contact to a case by passing in Contact for a type, you must have DescribeContact permission on the ARN of the contact that you provide in content.contact.contactArn.
  • A Related Item is a resource that is associated with a case. It may or may not have an external identifier linking it to an external resource (for example, a contactArn). All Related Items have their own internal identifier, the relatedItemArn. Examples of related items include comments and contacts.
  • If you provide a value for performedBy.userArn you must also have DescribeUser permission on the ARN of the user that you provide.
  • The type field is reserved for internal use only.
Endpoints: See Amazon Connect endpoints and quotas.

Parameters

-CaseId <String>
A unique identifier of the case.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonConnectCasesConfig>
Amazon.PowerShell.Cmdlets.CCAS.AmazonConnectCasesClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Comment_Body <String>
Text in the body of a Comment on a case.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Comment_Body
-Comment_ContentType <CommentBodyTextType>
Type of the text in the box of a Comment on a case.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Comment_ContentType
-ConnectCase_CaseId <String>
A unique identifier of the case.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_ConnectCase_CaseId
-Contact_ContactArn <String>
A unique identifier of a contact in Amazon Connect.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Contact_ContactArn
-Custom_Field <FieldValue[]>
List of field values for the Custom related item. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Custom_Fields
-DomainId <String>
The unique identifier of the Cases domain.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-File_FileArn <String>
The Amazon Resource Name (ARN) of a File in Amazon Connect.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_File_FileArn
-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)
-PerformedBy_CustomEntity <String>
Any provided entity.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PerformedBy_UserArn <String>
Represents the Amazon Connect ARN of the user.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConnectCases.Model.CreateRelatedItemResponse). Specifying the name of a property of type Amazon.ConnectCases.Model.CreateRelatedItemResponse 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)
-SlaInputConfiguration_FieldId <String>
Unique identifier of a field.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Sla_SlaInputConfiguration_FieldId
-SlaInputConfiguration_Name <String>
Name of an SLA.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Sla_SlaInputConfiguration_Name
-SlaInputConfiguration_TargetFieldValue <FieldValueUnion[]>
Represents a list of target field values for the fieldId specified in SlaInputConfiguration. The SLA is considered met if any one of these target field values matches the actual field value. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Sla_SlaInputConfiguration_TargetFieldValues
-SlaInputConfiguration_TargetSlaMinute <Int64>
Target duration in minutes within which an SLA should be completed.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Sla_SlaInputConfiguration_TargetSlaMinutes
-SlaInputConfiguration_Type <SlaType>
Type of SLA.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContent_Sla_SlaInputConfiguration_Type
-Type <RelatedItemType>
The type of a related item.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)

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

Amazon.ConnectCases.Model.CreateRelatedItemResponse
This cmdlet returns an Amazon.ConnectCases.Model.CreateRelatedItemResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

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