Skip to content

Commit

Permalink
feat(client-connect): Updates the *InstanceStorageConfig APIs to supp…
Browse files Browse the repository at this point in the history
…ort a new ResourceType: SCREEN_RECORDINGS to enable screen recording and specify the storage configurations for publishing the recordings. Also updates DescribeInstance and ListInstances APIs to include InstanceAccessUrl attribute in the API response.
  • Loading branch information
awstools committed Jun 16, 2023
1 parent 8d894a1 commit fa804c5
Show file tree
Hide file tree
Showing 13 changed files with 47 additions and 15 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ export interface AssociateInstanceStorageConfigCommandOutput
* const client = new ConnectClient(config);
* const input = { // AssociateInstanceStorageConfigRequest
* InstanceId: "STRING_VALUE", // required
* ResourceType: "CHAT_TRANSCRIPTS" || "CALL_RECORDINGS" || "SCHEDULED_REPORTS" || "MEDIA_STREAMS" || "CONTACT_TRACE_RECORDS" || "AGENT_EVENTS" || "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS" || "ATTACHMENTS" || "CONTACT_EVALUATIONS", // required
* ResourceType: "CHAT_TRANSCRIPTS" || "CALL_RECORDINGS" || "SCHEDULED_REPORTS" || "MEDIA_STREAMS" || "CONTACT_TRACE_RECORDS" || "AGENT_EVENTS" || "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS" || "ATTACHMENTS" || "CONTACT_EVALUATIONS" || "SCREEN_RECORDINGS", // required
* StorageConfig: { // InstanceStorageConfig
* AssociationId: "STRING_VALUE",
* StorageType: "S3" || "KINESIS_VIDEO_STREAM" || "KINESIS_STREAM" || "KINESIS_FIREHOSE", // required
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ export interface DescribeInstanceCommandOutput extends DescribeInstanceResponse,
* // },
* // InboundCallsEnabled: true || false,
* // OutboundCallsEnabled: true || false,
* // InstanceAccessUrl: "STRING_VALUE",
* // },
* // };
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ export interface DescribeInstanceStorageConfigCommandOutput
* const input = { // DescribeInstanceStorageConfigRequest
* InstanceId: "STRING_VALUE", // required
* AssociationId: "STRING_VALUE", // required
* ResourceType: "CHAT_TRANSCRIPTS" || "CALL_RECORDINGS" || "SCHEDULED_REPORTS" || "MEDIA_STREAMS" || "CONTACT_TRACE_RECORDS" || "AGENT_EVENTS" || "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS" || "ATTACHMENTS" || "CONTACT_EVALUATIONS", // required
* ResourceType: "CHAT_TRANSCRIPTS" || "CALL_RECORDINGS" || "SCHEDULED_REPORTS" || "MEDIA_STREAMS" || "CONTACT_TRACE_RECORDS" || "AGENT_EVENTS" || "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS" || "ATTACHMENTS" || "CONTACT_EVALUATIONS" || "SCREEN_RECORDINGS", // required
* };
* const command = new DescribeInstanceStorageConfigCommand(input);
* const response = await client.send(command);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ export interface DisassociateInstanceStorageConfigCommandOutput extends __Metada
* const input = { // DisassociateInstanceStorageConfigRequest
* InstanceId: "STRING_VALUE", // required
* AssociationId: "STRING_VALUE", // required
* ResourceType: "CHAT_TRANSCRIPTS" || "CALL_RECORDINGS" || "SCHEDULED_REPORTS" || "MEDIA_STREAMS" || "CONTACT_TRACE_RECORDS" || "AGENT_EVENTS" || "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS" || "ATTACHMENTS" || "CONTACT_EVALUATIONS", // required
* ResourceType: "CHAT_TRANSCRIPTS" || "CALL_RECORDINGS" || "SCHEDULED_REPORTS" || "MEDIA_STREAMS" || "CONTACT_TRACE_RECORDS" || "AGENT_EVENTS" || "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS" || "ATTACHMENTS" || "CONTACT_EVALUATIONS" || "SCREEN_RECORDINGS", // required
* };
* const command = new DisassociateInstanceStorageConfigCommand(input);
* const response = await client.send(command);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ export interface ListInstanceStorageConfigsCommandOutput extends ListInstanceSto
* const client = new ConnectClient(config);
* const input = { // ListInstanceStorageConfigsRequest
* InstanceId: "STRING_VALUE", // required
* ResourceType: "CHAT_TRANSCRIPTS" || "CALL_RECORDINGS" || "SCHEDULED_REPORTS" || "MEDIA_STREAMS" || "CONTACT_TRACE_RECORDS" || "AGENT_EVENTS" || "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS" || "ATTACHMENTS" || "CONTACT_EVALUATIONS", // required
* ResourceType: "CHAT_TRANSCRIPTS" || "CALL_RECORDINGS" || "SCHEDULED_REPORTS" || "MEDIA_STREAMS" || "CONTACT_TRACE_RECORDS" || "AGENT_EVENTS" || "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS" || "ATTACHMENTS" || "CONTACT_EVALUATIONS" || "SCREEN_RECORDINGS", // required
* NextToken: "STRING_VALUE",
* MaxResults: Number("int"),
* };
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ export interface ListInstancesCommandOutput extends ListInstancesResponse, __Met
* // InstanceStatus: "CREATION_IN_PROGRESS" || "ACTIVE" || "CREATION_FAILED",
* // InboundCallsEnabled: true || false,
* // OutboundCallsEnabled: true || false,
* // InstanceAccessUrl: "STRING_VALUE",
* // },
* // ],
* // NextToken: "STRING_VALUE",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ export interface ResumeContactRecordingCommandOutput extends ResumeContactRecord
/**
* @public
* <p>When a contact is being recorded, and the recording has been suspended using
* SuspendContactRecording, this API resumes recording the call.</p>
* <p>Only voice recordings are supported at this time.</p>
* SuspendContactRecording, this API resumes recording the call or screen.</p>
* <p>Voice and screen recordings are supported.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,11 @@ export interface SuspendContactRecordingCommandOutput extends SuspendContactReco

/**
* @public
* <p>When a contact is being recorded, this API suspends recording the call. For example, you
* might suspend the call recording while collecting sensitive information, such as a credit card
* number. Then use ResumeContactRecording to restart recording. </p>
* <p>The period of time that the recording is suspended is filled with silence in the final
* recording. </p>
* <p>Only voice recordings are supported at this time.</p>
* <p>When a contact is being recorded, this API suspends recording the call or screen. For
* example, you might suspend the call or screen recording while collecting sensitive
* information, such as a credit card number. Then use ResumeContactRecording to restart recording.</p>
* <p>The period of time that the recording is suspended is filled with silence in the final recording.</p>
* <p>Voice and screen recordings are supported.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ export interface UpdateInstanceStorageConfigCommandOutput extends __MetadataBear
* const input = { // UpdateInstanceStorageConfigRequest
* InstanceId: "STRING_VALUE", // required
* AssociationId: "STRING_VALUE", // required
* ResourceType: "CHAT_TRANSCRIPTS" || "CALL_RECORDINGS" || "SCHEDULED_REPORTS" || "MEDIA_STREAMS" || "CONTACT_TRACE_RECORDS" || "AGENT_EVENTS" || "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS" || "ATTACHMENTS" || "CONTACT_EVALUATIONS", // required
* ResourceType: "CHAT_TRANSCRIPTS" || "CALL_RECORDINGS" || "SCHEDULED_REPORTS" || "MEDIA_STREAMS" || "CONTACT_TRACE_RECORDS" || "AGENT_EVENTS" || "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS" || "ATTACHMENTS" || "CONTACT_EVALUATIONS" || "SCREEN_RECORDINGS", // required
* StorageConfig: { // InstanceStorageConfig
* AssociationId: "STRING_VALUE",
* StorageType: "S3" || "KINESIS_VIDEO_STREAM" || "KINESIS_STREAM" || "KINESIS_FIREHOSE", // required
Expand Down
6 changes: 6 additions & 0 deletions clients/client-connect/src/models/models_0.ts
Original file line number Diff line number Diff line change
Expand Up @@ -689,6 +689,7 @@ export const InstanceStorageResourceType = {
MEDIA_STREAMS: "MEDIA_STREAMS",
REAL_TIME_CONTACT_ANALYSIS_SEGMENTS: "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS",
SCHEDULED_REPORTS: "SCHEDULED_REPORTS",
SCREEN_RECORDINGS: "SCREEN_RECORDINGS",
} as const;

/**
Expand Down Expand Up @@ -4830,6 +4831,11 @@ export interface Instance {
* <p>Whether outbound calls are enabled.</p>
*/
OutboundCallsEnabled?: boolean;

/**
* <p>This URL allows contact center users to access Amazon Connect admin website.</p>
*/
InstanceAccessUrl?: string;
}

/**
Expand Down
5 changes: 5 additions & 0 deletions clients/client-connect/src/models/models_1.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2525,6 +2525,11 @@ export interface InstanceSummary {
* <p>Whether outbound calls are enabled.</p>
*/
OutboundCallsEnabled?: boolean;

/**
* <p>This URL allows contact center users to access Amazon Connect admin website.</p>
*/
InstanceAccessUrl?: string;
}

/**
Expand Down
2 changes: 2 additions & 0 deletions clients/client-connect/src/protocols/Aws_restJson1.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20182,6 +20182,7 @@ const de_Instance = (output: any, context: __SerdeContext): Instance => {
Id: __expectString,
IdentityManagementType: __expectString,
InboundCallsEnabled: __expectBoolean,
InstanceAccessUrl: __expectString,
InstanceAlias: __expectString,
InstanceStatus: __expectString,
OutboundCallsEnabled: __expectBoolean,
Expand All @@ -20206,6 +20207,7 @@ const de_InstanceSummary = (output: any, context: __SerdeContext): InstanceSumma
Id: __expectString,
IdentityManagementType: __expectString,
InboundCallsEnabled: __expectBoolean,
InstanceAccessUrl: __expectString,
InstanceAlias: __expectString,
InstanceStatus: __expectString,
OutboundCallsEnabled: __expectBoolean,
Expand Down
22 changes: 20 additions & 2 deletions codegen/sdk-codegen/aws-models/connect.json
Original file line number Diff line number Diff line change
Expand Up @@ -13388,6 +13388,12 @@
"traits": {
"smithy.api#documentation": "<p>Whether outbound calls are enabled.</p>"
}
},
"InstanceAccessUrl": {
"target": "com.amazonaws.connect#Url",
"traits": {
"smithy.api#documentation": "<p>This URL allows contact center users to access Amazon Connect admin website.</p>"
}
}
},
"traits": {
Expand Down Expand Up @@ -13637,6 +13643,12 @@
"traits": {
"smithy.api#enumValue": "CONTACT_EVALUATIONS"
}
},
"SCREEN_RECORDINGS": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "SCREEN_RECORDINGS"
}
}
}
},
Expand Down Expand Up @@ -13696,6 +13708,12 @@
"traits": {
"smithy.api#documentation": "<p>Whether outbound calls are enabled.</p>"
}
},
"InstanceAccessUrl": {
"target": "com.amazonaws.connect#Url",
"traits": {
"smithy.api#documentation": "<p>This URL allows contact center users to access Amazon Connect admin website.</p>"
}
}
},
"traits": {
Expand Down Expand Up @@ -21402,7 +21420,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>When a contact is being recorded, and the recording has been suspended using\n SuspendContactRecording, this API resumes recording the call.</p>\n <p>Only voice recordings are supported at this time.</p>",
"smithy.api#documentation": "<p>When a contact is being recorded, and the recording has been suspended using \n SuspendContactRecording, this API resumes recording the call or screen.</p>\n <p>Voice and screen recordings are supported.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/contact/resume-recording",
Expand Down Expand Up @@ -24583,7 +24601,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>When a contact is being recorded, this API suspends recording the call. For example, you\n might suspend the call recording while collecting sensitive information, such as a credit card\n number. Then use ResumeContactRecording to restart recording. </p>\n <p>The period of time that the recording is suspended is filled with silence in the final\n recording. </p>\n <p>Only voice recordings are supported at this time.</p>",
"smithy.api#documentation": "<p>When a contact is being recorded, this API suspends recording the call or screen. For \n example, you might suspend the call or screen recording while collecting sensitive \n information, such as a credit card number. Then use ResumeContactRecording to restart recording.</p>\n <p>The period of time that the recording is suspended is filled with silence in the final recording.</p>\n <p>Voice and screen recordings are supported.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/contact/suspend-recording",
Expand Down

0 comments on commit fa804c5

Please sign in to comment.