diff --git a/CHANGELOG.md b/CHANGELOG.md index d80a5302b22..3f6f37ca351 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,11 @@ +Release v1.53.2 (2024-05-14) +=== + +### Service Client Updates +* `service/connect`: Updates service API, documentation, and paginators +* `service/s3`: Updates service API and examples + * Updated a few x-id in the http uri traits + Release v1.53.1 (2024-05-13) === diff --git a/aws/endpoints/defaults.go b/aws/endpoints/defaults.go index 0fdd67b459c..69d7e19cb41 100644 --- a/aws/endpoints/defaults.go +++ b/aws/endpoints/defaults.go @@ -1075,6 +1075,9 @@ var awsPartition = partition{ endpointKey{ Region: "eu-west-1", }: endpoint{}, + endpointKey{ + Region: "eu-west-2", + }: endpoint{}, endpointKey{ Region: "eu-west-3", }: endpoint{}, diff --git a/aws/version.go b/aws/version.go index 9150247556f..5df00f9892d 100644 --- a/aws/version.go +++ b/aws/version.go @@ -5,4 +5,4 @@ package aws const SDKName = "aws-sdk-go" // SDKVersion is the version of this SDK -const SDKVersion = "1.53.1" +const SDKVersion = "1.53.2" diff --git a/models/apis/connect/2017-08-08/api-2.json b/models/apis/connect/2017-08-08/api-2.json index 03b1a11e51a..54eeec7b7d0 100644 --- a/models/apis/connect/2017-08-08/api-2.json +++ b/models/apis/connect/2017-08-08/api-2.json @@ -2815,6 +2815,38 @@ {"shape":"AccessDeniedException"} ] }, + "SearchContactFlowModules":{ + "name":"SearchContactFlowModules", + "http":{ + "method":"POST", + "requestUri":"/search-contact-flow-modules" + }, + "input":{"shape":"SearchContactFlowModulesRequest"}, + "output":{"shape":"SearchContactFlowModulesResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceException"} + ] + }, + "SearchContactFlows":{ + "name":"SearchContactFlows", + "http":{ + "method":"POST", + "requestUri":"/search-contact-flows" + }, + "input":{"shape":"SearchContactFlowsRequest"}, + "output":{"shape":"SearchContactFlowsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceException"} + ] + }, "SearchContacts":{ "name":"SearchContacts", "http":{ @@ -5166,6 +5198,7 @@ "Name":{"shape":"ContactFlowName"}, "Type":{"shape":"ContactFlowType"}, "State":{"shape":"ContactFlowState"}, + "Status":{"shape":"ContactFlowStatus"}, "Description":{"shape":"ContactFlowDescription"}, "Content":{"shape":"ContactFlowContent"}, "Tags":{"shape":"TagMap"} @@ -5212,6 +5245,28 @@ "min":1, "pattern":".*\\S.*" }, + "ContactFlowModuleSearchConditionList":{ + "type":"list", + "member":{"shape":"ContactFlowModuleSearchCriteria"} + }, + "ContactFlowModuleSearchCriteria":{ + "type":"structure", + "members":{ + "OrConditions":{"shape":"ContactFlowModuleSearchConditionList"}, + "AndConditions":{"shape":"ContactFlowModuleSearchConditionList"}, + "StringCondition":{"shape":"StringCondition"} + } + }, + "ContactFlowModuleSearchFilter":{ + "type":"structure", + "members":{ + "TagFilter":{"shape":"ControlPlaneTagFilter"} + } + }, + "ContactFlowModuleSearchSummaryList":{ + "type":"list", + "member":{"shape":"ContactFlowModule"} + }, "ContactFlowModuleState":{ "type":"string", "enum":[ @@ -5251,6 +5306,31 @@ "error":{"httpStatusCode":404}, "exception":true }, + "ContactFlowSearchConditionList":{ + "type":"list", + "member":{"shape":"ContactFlowSearchCriteria"} + }, + "ContactFlowSearchCriteria":{ + "type":"structure", + "members":{ + "OrConditions":{"shape":"ContactFlowSearchConditionList"}, + "AndConditions":{"shape":"ContactFlowSearchConditionList"}, + "StringCondition":{"shape":"StringCondition"}, + "TypeCondition":{"shape":"ContactFlowType"}, + "StateCondition":{"shape":"ContactFlowState"}, + "StatusCondition":{"shape":"ContactFlowStatus"} + } + }, + "ContactFlowSearchFilter":{ + "type":"structure", + "members":{ + "TagFilter":{"shape":"ControlPlaneTagFilter"} + } + }, + "ContactFlowSearchSummaryList":{ + "type":"list", + "member":{"shape":"ContactFlow"} + }, "ContactFlowState":{ "type":"string", "enum":[ @@ -5258,6 +5338,13 @@ "ARCHIVED" ] }, + "ContactFlowStatus":{ + "type":"string", + "enum":[ + "PUBLISHED", + "SAVED" + ] + }, "ContactFlowSummary":{ "type":"structure", "members":{ @@ -5265,7 +5352,8 @@ "Arn":{"shape":"ARN"}, "Name":{"shape":"ContactFlowName"}, "ContactFlowType":{"shape":"ContactFlowType"}, - "ContactFlowState":{"shape":"ContactFlowState"} + "ContactFlowState":{"shape":"ContactFlowState"}, + "ContactFlowStatus":{"shape":"ContactFlowStatus"} } }, "ContactFlowSummaryList":{ @@ -5515,6 +5603,7 @@ "Type":{"shape":"ContactFlowType"}, "Description":{"shape":"ContactFlowDescription"}, "Content":{"shape":"ContactFlowContent"}, + "Status":{"shape":"ContactFlowStatus"}, "Tags":{"shape":"TagMap"} } }, @@ -13093,6 +13182,50 @@ "AvailableNumbersList":{"shape":"AvailableNumbersList"} } }, + "SearchContactFlowModulesRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{"shape":"InstanceId"}, + "NextToken":{"shape":"NextToken2500"}, + "MaxResults":{ + "shape":"MaxResult100", + "box":true + }, + "SearchFilter":{"shape":"ContactFlowModuleSearchFilter"}, + "SearchCriteria":{"shape":"ContactFlowModuleSearchCriteria"} + } + }, + "SearchContactFlowModulesResponse":{ + "type":"structure", + "members":{ + "ContactFlowModules":{"shape":"ContactFlowModuleSearchSummaryList"}, + "NextToken":{"shape":"NextToken2500"}, + "ApproximateTotalCount":{"shape":"ApproximateTotalCount"} + } + }, + "SearchContactFlowsRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{"shape":"InstanceId"}, + "NextToken":{"shape":"NextToken2500"}, + "MaxResults":{ + "shape":"MaxResult100", + "box":true + }, + "SearchFilter":{"shape":"ContactFlowSearchFilter"}, + "SearchCriteria":{"shape":"ContactFlowSearchCriteria"} + } + }, + "SearchContactFlowsResponse":{ + "type":"structure", + "members":{ + "ContactFlows":{"shape":"ContactFlowSearchSummaryList"}, + "NextToken":{"shape":"NextToken2500"}, + "ApproximateTotalCount":{"shape":"ApproximateTotalCount"} + } + }, "SearchContactsMatchType":{ "type":"string", "enum":[ diff --git a/models/apis/connect/2017-08-08/docs-2.json b/models/apis/connect/2017-08-08/docs-2.json index ba111a7b355..4c83b41eb8d 100644 --- a/models/apis/connect/2017-08-08/docs-2.json +++ b/models/apis/connect/2017-08-08/docs-2.json @@ -75,8 +75,8 @@ "DescribeAgentStatus": "
This API is in preview release for Amazon Connect and is subject to change.
Describes an agent status.
", "DescribeContact": "This API is in preview release for Amazon Connect and is subject to change.
Describes the specified contact.
Contact information remains available in Amazon Connect for 24 months, and then it is deleted.
Only data from November 12, 2021, and later is returned by this API.
Describes a contact evaluation in the specified Amazon Connect instance.
", - "DescribeContactFlow": "Describes the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
", - "DescribeContactFlowModule": "Describes the specified flow module.
", + "DescribeContactFlow": "Describes the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
Use the $SAVED
alias in the request to describe the SAVED
content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED
. Once a contact flow is published, $SAVED
needs to be supplied to view saved content that has not been published.
In the response, Status indicates the flow status as either SAVED
or PUBLISHED
. The PUBLISHED
status will initiate validation on the content. SAVED
does not initiate validation of the content. SAVED
| PUBLISHED
Describes the specified flow module.
Use the $SAVED
alias in the request to describe the SAVED
content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED
. Once a contact flow is published, $SAVED
needs to be supplied to view saved content that has not been published.
Describes an evaluation form in the specified Amazon Connect instance. If the version property is not provided, the latest version of the evaluation form is described.
", "DescribeHoursOfOperation": "This API is in preview release for Amazon Connect and is subject to change.
Describes the hours of operation.
", "DescribeInstance": "This API is in preview release for Amazon Connect and is subject to change.
Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status, if applicable.
If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked.
", @@ -174,6 +174,8 @@ "ResumeContact": "Allows resuming a task contact in a paused state.
", "ResumeContactRecording": "When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording whatever recording is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would resume.
Voice and screen recordings are supported.
", "SearchAvailablePhoneNumbers": "Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group. If the provided TargetArn
is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with the traffic distribution group.
Searches the flow modules in an Amazon Connect instance, with optional filtering.
", + "SearchContactFlows": "Searches the contact flows in an Amazon Connect instance, with optional filtering.
", "SearchContacts": "Searches contacts in an Amazon Connect instance.
", "SearchHoursOfOperations": "Searches the hours of operation in an Amazon Connect instance, with optional filtering.
", "SearchPredefinedAttributes": "Predefined attributes that meet certain criteria.
", @@ -208,9 +210,9 @@ "UpdateContact": "This API is in preview release for Amazon Connect and is subject to change.
Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request.
You can add or update user-defined contact information for both ongoing and completed contacts.
Creates or updates user-defined contact attributes associated with the specified contact.
You can create or update user-defined attributes for both ongoing and completed contacts. For example, while the call is active, you can update the customer's name or the reason the customer called. You can add notes about steps that the agent took during the call that display to the next agent that takes the call. You can also update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or to identify abusive callers.
Contact attributes are available in Amazon Connect for 24 months, and are then deleted. For information about contact record retention and the maximum size of the contact record attributes section, see Feature specifications in the Amazon Connect Administrator Guide.
", "UpdateContactEvaluation": "Updates details about a contact evaluation in the specified Amazon Connect instance. A contact evaluation must be in draft state. Answers included in the request are merged with existing answers for the given evaluation. An answer or note can be deleted by passing an empty object ({}
) to the question identifier.
Updates the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
", + "UpdateContactFlowContent": "Updates the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
Use the $SAVED
alias in the request to describe the SAVED
content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED
. Once a contact flow is published, $SAVED
needs to be supplied to view saved content that has not been published.
Updates metadata about specified flow.
", - "UpdateContactFlowModuleContent": "Updates specified flow module for the specified Amazon Connect instance.
", + "UpdateContactFlowModuleContent": "Updates specified flow module for the specified Amazon Connect instance.
Use the $SAVED
alias in the request to describe the SAVED
content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED
. Once a contact flow is published, $SAVED
needs to be supplied to view saved content that has not been published.
Updates metadata about specified flow module.
", "UpdateContactFlowName": "The name of the flow.
You can also create and update flows using the Amazon Connect Flow language.
", "UpdateContactRoutingData": "This API is in preview release for Amazon Connect and is subject to change.
Updates routing priority and age on the contact (QueuePriority and QueueTimeAdjustmentInSeconds). These properties can be used to change a customer's position in the queue. For example, you can move a contact to the back of the queue by setting a lower routing priority relative to other contacts in queue; or you can move a contact to the front of the queue by increasing the routing age which will make the contact look artificially older and therefore higher up in the first-in-first-out routing order. Note that adjusting the routing age of a contact affects only its position in queue, and not its actual queue wait time as reported through metrics. These properties can also be updated by using the Set routing priority / age flow block.
", @@ -321,7 +323,7 @@ "FlowAssociationSummary$FlowId": "The identifier of the flow.
", "GetAttachedFileRequest$AssociatedResourceArn": "The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
This value must be a valid ARN.
The unique identifier of the attached file resource (ARN).
", - "GetAttachedFileResponse$AssociatedResourceArn": "The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
This value must be a valid ARN.
The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
", "GetFederationTokenResponse$UserArn": "The Amazon Resource Name (ARN) of the user.
", "GetFlowAssociationRequest$ResourceId": "The identifier of the resource.
", "GetFlowAssociationResponse$ResourceId": "The identifier of the resource.
", @@ -692,6 +694,8 @@ "refs": { "GetCurrentMetricDataResponse$ApproximateTotalCount": "The total count of the result, regardless of the current page size.
", "GetCurrentUserDataResponse$ApproximateTotalCount": "The total count of the result, regardless of the current page size.
", + "SearchContactFlowModulesResponse$ApproximateTotalCount": "The total number of contact flows which matched your search query.
", + "SearchContactFlowsResponse$ApproximateTotalCount": "The total number of contact flows which matched your search query.
", "SearchHoursOfOperationsResponse$ApproximateTotalCount": "The total number of hours of operations which matched your search query.
", "SearchPredefinedAttributesResponse$ApproximateTotalCount": "The approximate number of predefined attributes which matched your search query.
", "SearchPromptsResponse$ApproximateTotalCount": "The total number of quick connects which matched your search query.
", @@ -1297,6 +1301,7 @@ "ContactFlow": { "base": "Contains information about a flow.
", "refs": { + "ContactFlowSearchSummaryList$member": null, "DescribeContactFlowResponse$ContactFlow": "Information about the flow.
" } }, @@ -1349,6 +1354,7 @@ "ContactFlowModule": { "base": "Contains information about a flow module.
", "refs": { + "ContactFlowModuleSearchSummaryList$member": null, "DescribeContactFlowModuleResponse$ContactFlowModule": "Information about the flow module.
" } }, @@ -1389,6 +1395,32 @@ "UpdateContactFlowModuleMetadataRequest$Name": "The name of the flow module.
" } }, + "ContactFlowModuleSearchConditionList": { + "base": null, + "refs": { + "ContactFlowModuleSearchCriteria$OrConditions": "A list of conditions which would be applied together with an OR
condition.
A list of conditions which would be applied together with an AND
condition.
The search criteria to be used to return flow modules.
", + "refs": { + "ContactFlowModuleSearchConditionList$member": null, + "SearchContactFlowModulesRequest$SearchCriteria": "The search criteria to be used to return contact flow modules.
The name
and description
fields support \"contains\" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will result in invalid results.
The search criteria to be used to return flow modules.
", + "refs": { + "SearchContactFlowModulesRequest$SearchFilter": "Filters to be applied to search results.
" + } + }, + "ContactFlowModuleSearchSummaryList": { + "base": null, + "refs": { + "SearchContactFlowModulesResponse$ContactFlowModules": "The search criteria to be used to return contact flow modules.
" + } + }, "ContactFlowModuleState": { "base": null, "refs": { @@ -1431,14 +1463,50 @@ "refs": { } }, + "ContactFlowSearchConditionList": { + "base": null, + "refs": { + "ContactFlowSearchCriteria$OrConditions": "A list of conditions which would be applied together with an OR
condition.
A list of conditions which would be applied together with an AND
condition.
The search criteria to be used to return contact flows.
", + "refs": { + "ContactFlowSearchConditionList$member": null, + "SearchContactFlowsRequest$SearchCriteria": "The search criteria to be used to return flows.
The name
and description
fields support \"contains\" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will result in invalid results.
Filters to be applied to search results.
", + "refs": { + "SearchContactFlowsRequest$SearchFilter": "Filters to be applied to search results.
" + } + }, + "ContactFlowSearchSummaryList": { + "base": null, + "refs": { + "SearchContactFlowsResponse$ContactFlows": "Information about the contact flows.
" + } + }, "ContactFlowState": { "base": null, "refs": { "ContactFlow$State": "The type of flow.
", + "ContactFlowSearchCriteria$StateCondition": "The state of the flow.
", "ContactFlowSummary$ContactFlowState": "The type of flow.
", "UpdateContactFlowMetadataRequest$ContactFlowState": "The state of flow.
" } }, + "ContactFlowStatus": { + "base": null, + "refs": { + "ContactFlow$Status": "The status of the contact flow.
", + "ContactFlowSearchCriteria$StatusCondition": "The status of the flow.
", + "ContactFlowSummary$ContactFlowStatus": "The status of the contact flow.
", + "CreateContactFlowRequest$Status": "Indicates the flow status as either SAVED
or PUBLISHED
. The PUBLISHED
status will initiate validation on the content. the SAVED
status does not initiate validation of the content. SAVED
| PUBLISHED
.
Contains summary information about a flow.
You can also create and update flows using the Amazon Connect Flow language.
", "refs": { @@ -1455,6 +1523,7 @@ "base": null, "refs": { "ContactFlow$Type": "The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide.
", + "ContactFlowSearchCriteria$TypeCondition": "The type of flow.
", "ContactFlowSummary$ContactFlowType": "The type of flow.
", "ContactFlowTypes$member": null, "CreateContactFlowRequest$Type": "The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide.
" @@ -1630,6 +1699,8 @@ "ControlPlaneTagFilter": { "base": "An object that can be used to specify Tag conditions inside the SearchFilter
. This accepts an OR
of AND
(List of List) input where:
Top level list specifies conditions that need to be applied with OR
operator
Inner list specifies conditions that need to be applied with AND
operator.
The filters to apply to returned metrics. You can filter on the following resources:
Queues
Routing profiles
Agents
Channels
User hierarchy groups
Feature
Routing step expression
At least one filter must be passed from queues, routing profiles, agents, or user hierarchy groups.
To filter by phone number, see Create a historical metrics report in the Amazon Connect Administrator's Guide.
Note the following limits:
Filter keys: A maximum of 5 filter keys are supported in a single request. Valid filter keys: QUEUE
| ROUTING_PROFILE
| AGENT
| CHANNEL
| AGENT_HIERARCHY_LEVEL_ONE
| AGENT_HIERARCHY_LEVEL_TWO
| AGENT_HIERARCHY_LEVEL_THREE
| AGENT_HIERARCHY_LEVEL_FOUR
| AGENT_HIERARCHY_LEVEL_FIVE
| FEATURE
| CASE_TEMPLATE_ARN
| CASE_STATUS
| contact/segmentAttributes/connect:Subtype
| ROUTING_STEP_EXPRESSION
Filter values: A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are valid filterValue
for the CHANNEL filter key. They do not count towards limitation of 100 filter values. For example, a GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values, along with 3 channel filters.
contact_lens_conversational_analytics
is a valid filterValue for the FEATURE
filter key. It is available only to contacts analyzed by Contact Lens conversational analytics.
connect:Chat
, connect:SMS
, connect:Telephony
, and connect:WebRTC
are valid filterValue
examples (not exhaustive) for the contact/segmentAttributes/connect:Subtype filter
key.
ROUTING_STEP_EXPRESSION
is a valid filter key with a filter value up to 3000 length. This filter is case and order sensitive. JSON string fields must be sorted in ascending order and JSON array order should be kept as is.
The filters to apply to returned metrics. You can filter on the following resources:
Queues
Routing profiles
Agents
Channels
User hierarchy groups
Feature
Routing step expression
At least one filter must be passed from queues, routing profiles, agents, or user hierarchy groups.
To filter by phone number, see Create a historical metrics report in the Amazon Connect Administrator's Guide.
Note the following limits:
Filter keys: A maximum of 5 filter keys are supported in a single request. Valid filter keys: QUEUE
| ROUTING_PROFILE
| AGENT
| CHANNEL
| AGENT_HIERARCHY_LEVEL_ONE
| AGENT_HIERARCHY_LEVEL_TWO
| AGENT_HIERARCHY_LEVEL_THREE
| AGENT_HIERARCHY_LEVEL_FOUR
| AGENT_HIERARCHY_LEVEL_FIVE
| FEATURE
| CASE_TEMPLATE_ARN
| CASE_STATUS
| contact/segmentAttributes/connect:Subtype
| ROUTING_STEP_EXPRESSION
| Q_CONNECT_ENABLED
Filter values: A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are valid filterValue
for the CHANNEL filter key. They do not count towards limitation of 100 filter values. For example, a GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values, along with 3 channel filters.
contact_lens_conversational_analytics
is a valid filterValue for the FEATURE
filter key. It is available only to contacts analyzed by Contact Lens conversational analytics.
connect:Chat
, connect:SMS
, connect:Telephony
, and connect:WebRTC
are valid filterValue
examples (not exhaustive) for the contact/segmentAttributes/connect:Subtype filter
key.
ROUTING_STEP_EXPRESSION
is a valid filter key with a filter value up to 3000 length. This filter is case and order sensitive. JSON string fields must be sorted in ascending order and JSON array order should be kept as is.
Q_CONNECT_ENABLED
. TRUE and FALSE are the only valid filterValues for the Q_CONNECT_ENABLED
filter key.
TRUE includes all contacts that had Amazon Q in Connect enabled as part of the flow.
FALSE includes all contacts that did not have Amazon Q in Connect enabled as part of the flow
This filter is available only for contact record-driven metrics.
The grouping applied to the metrics that are returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values that are returned apply to the metrics for each queue. They are not aggregated for all queues.
If no grouping is specified, a summary of all metrics is returned.
Valid grouping keys: QUEUE
| ROUTING_PROFILE
| AGENT
| CHANNEL
| AGENT_HIERARCHY_LEVEL_ONE
| AGENT_HIERARCHY_LEVEL_TWO
| AGENT_HIERARCHY_LEVEL_THREE
| AGENT_HIERARCHY_LEVEL_FOUR
| AGENT_HIERARCHY_LEVEL_FIVE
| CASE_TEMPLATE_ARN
| CASE_STATUS
| contact/segmentAttributes/connect:Subtype
| ROUTING_STEP_EXPRESSION
The grouping applied to the metrics that are returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values that are returned apply to the metrics for each queue. They are not aggregated for all queues.
If no grouping is specified, a summary of all metrics is returned.
Valid grouping keys: QUEUE
| ROUTING_PROFILE
| AGENT
| CHANNEL
| AGENT_HIERARCHY_LEVEL_ONE
| AGENT_HIERARCHY_LEVEL_TWO
| AGENT_HIERARCHY_LEVEL_THREE
| AGENT_HIERARCHY_LEVEL_FOUR
| AGENT_HIERARCHY_LEVEL_FIVE
| CASE_TEMPLATE_ARN
| CASE_STATUS
| contact/segmentAttributes/connect:Subtype
| ROUTING_STEP_EXPRESSION
| Q_CONNECT_ENABLED
The identifier of the Amazon Connect instance. You can find the instanceId
in the ARN of the instance.
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "SearchAvailablePhoneNumbersRequest$InstanceId": "The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId
or TargetArn
.
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", + "SearchContactFlowsRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "SearchContactsRequest$InstanceId": "The identifier of Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "SearchHoursOfOperationsRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "SearchPredefinedAttributesRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", @@ -4769,6 +4842,8 @@ "ListTaskTemplatesRequest$MaxResults": "The maximum number of results to return per page.
It is not expected that you set this.
The maximum number of results to return per page.
", "ListUserProficienciesRequest$MaxResults": "The maximum number of results to return per page.
", + "SearchContactFlowModulesRequest$MaxResults": "The maximum number of results to return per page.
", + "SearchContactFlowsRequest$MaxResults": "The maximum number of results to return per page.
", "SearchContactsRequest$MaxResults": "The maximum number of results to return per page.
", "SearchHoursOfOperationsRequest$MaxResults": "The maximum number of results to return per page.
", "SearchPredefinedAttributesRequest$MaxResults": "The maximum number of results to return per page.
", @@ -4998,7 +5073,7 @@ "MetricsV2": { "base": null, "refs": { - "GetMetricDataV2Request$Metrics": "The metrics to retrieve. Specify the name, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator's Guide.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
UI name: Abandonment rate
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherent time
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent answer rate
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Non-adherent time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent non-response
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Data for this metric is available starting from October 1, 2023 0:00:00 GMT.
Unit: Percentage
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Occupancy
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherence
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Scheduled time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
UI name: Average queue abandon time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Average active time
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
UI name: Average after contact work time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
. For now, this metric only supports the following as INITIATION_METHOD
: INBOUND
| OUTBOUND
| CALLBACK
| API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Average agent API connecting time
The Negate
key in Metric Level Filters is not applicable for this metric.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Average agent pause time
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average contacts per case
Unit: Seconds
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average case resolution time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
UI name: Average contact duration
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
UI name: Average conversation duration
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Average agent greeting time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
UI name: Average handle time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
UI name: Average customer hold time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
UI name: Average holds
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype
UI name: Average agent interaction time
Feature is a valid filter but not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Average agent interruptions
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Average agent interruption time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Average non-talk time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype
UI name: Average queue answer time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
UI name: Average resolution time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Average talk time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Average agent talk time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Average customer talk time
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases created
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
UI name: Contact abandoned
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype
UI name: Contacts created
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD
, DISCONNECT_REASON
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
UI name: API contacts handled
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Contacts hold disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Contacts hold agent disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Contacts hold customer disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Contacts put on hold
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Contacts transferred out external
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Contacts transferred out internal
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Contacts queued
Unit: Count
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Contacts queued (enqueue timestamp)
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
Threshold: For ThresholdValue
enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter LT
(for \"Less than\").
UI name: Contacts resolved in X
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
UI name: Contacts transferred out
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Contacts transferred out by agent
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Contacts transferred out queue
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Current cases
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Maximum queued time
Unit: Percent
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved on first contact
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: Not available
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: Not available
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Non-talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Agent talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Customer talk time percent
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases reopened
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter LT
(for \"Less than\").
UI name: Service level X
Unit: Count
Valid groupings and filters: Queue, RoutingStepExpression
UI name: Not available
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: After contact work time
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
. This metric only supports the following filter keys as INITIATION_METHOD
: INBOUND
| OUTBOUND
| CALLBACK
| API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent API connecting time
The Negate
key in Metric Level Filters is not applicable for this metric.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Contact flow time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent on contact time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter LT
(for \"Less than\").
UI name: Contacts answered in X seconds
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter LT
(for \"Less than\").
UI name: Contacts abandoned in X seconds
Valid metric filter key: DISCONNECT_REASON
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Contact disconnected
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Error status time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Contact handle time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Customer hold time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Agent idle time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent interaction and hold time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent interaction time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Non-Productive Time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Online time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
UI name: Callback attempts
The metrics to retrieve. Specify the name, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator's Guide.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Abandonment rate
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherent time
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent answer rate
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Non-adherent time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent non-response
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Data for this metric is available starting from October 1, 2023 0:00:00 GMT.
Unit: Percentage
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Occupancy
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherence
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Scheduled time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average queue abandon time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Average active time
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average after contact work time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
. For now, this metric only supports the following as INITIATION_METHOD
: INBOUND
| OUTBOUND
| CALLBACK
| API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Average agent API connecting time
The Negate
key in Metric Level Filters is not applicable for this metric.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Average agent pause time
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average contacts per case
Unit: Seconds
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average case resolution time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average contact duration
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average conversation duration
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent greeting time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
UI name: Average handle time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average customer hold time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average holds
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interaction time
Feature is a valid filter but not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interruptions
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interruption time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average non-talk time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average queue answer time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average resolution time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average talk time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent talk time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average customer talk time
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases created
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
UI name: Contact abandoned
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts created
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD
, DISCONNECT_REASON
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
UI name: API contacts handled
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts hold disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts hold agent disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts hold customer disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts put on hold
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts transferred out external
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts transferred out internal
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts queued
Unit: Count
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Contacts queued (enqueue timestamp)
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue
enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter LT
(for \"Less than\").
UI name: Contacts resolved in X
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out by agent
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out queue
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Current cases
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Maximum queued time
Unit: Percent
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved on first contact
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: Not available
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: Not available
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Non-talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Agent talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Customer talk time percent
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases reopened
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter LT
(for \"Less than\").
UI name: Service level X
Unit: Count
Valid groupings and filters: Queue, RoutingStepExpression
UI name: Not available
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: After contact work time
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
. This metric only supports the following filter keys as INITIATION_METHOD
: INBOUND
| OUTBOUND
| CALLBACK
| API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent API connecting time
The Negate
key in Metric Level Filters is not applicable for this metric.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contact flow time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent on contact time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter LT
(for \"Less than\").
UI name: Contacts answered in X seconds
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter LT
(for \"Less than\").
UI name: Contacts abandoned in X seconds
Valid metric filter key: DISCONNECT_REASON
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contact disconnected
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Error status time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contact handle time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Customer hold time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Agent idle time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Agent interaction and hold time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent interaction time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Non-Productive Time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Online time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Callback attempts
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", "GetMetricDataV2Response$NextToken": "If there are additional results, this is the token for the next set of results.
", + "SearchContactFlowModulesRequest$NextToken": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", + "SearchContactFlowModulesResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", + "SearchContactFlowsRequest$NextToken": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", + "SearchContactFlowsResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "SearchHoursOfOperationsRequest$NextToken": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", "SearchHoursOfOperationsResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "SearchPredefinedAttributesRequest$NextToken": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", @@ -6753,6 +6832,26 @@ "refs": { } }, + "SearchContactFlowModulesRequest": { + "base": null, + "refs": { + } + }, + "SearchContactFlowModulesResponse": { + "base": null, + "refs": { + } + }, + "SearchContactFlowsRequest": { + "base": null, + "refs": { + } + }, + "SearchContactFlowsResponse": { + "base": null, + "refs": { + } + }, "SearchContactsMatchType": { "base": null, "refs": { @@ -7367,6 +7466,8 @@ "StringCondition": { "base": "A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName
are name
and description
.
A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName
are name
, description
, timezone
, and resourceID
.
A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName
are name
, description
, and resourceID
.
Optional override for the expiry of the pre-signed S3 URL in seconds.
", - "StartAttachedFileUploadRequest$UrlExpiryInSeconds": "Optional override for the expiry of the pre-signed S3 URL in seconds.
" + "GetAttachedFileRequest$UrlExpiryInSeconds": "Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.
", + "StartAttachedFileUploadRequest$UrlExpiryInSeconds": "Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.
" } }, "Unit": { diff --git a/models/apis/connect/2017-08-08/paginators-1.json b/models/apis/connect/2017-08-08/paginators-1.json index acbd137bca3..7ba21e5e2e0 100644 --- a/models/apis/connect/2017-08-08/paginators-1.json +++ b/models/apis/connect/2017-08-08/paginators-1.json @@ -295,6 +295,24 @@ "output_token": "NextToken", "result_key": "AvailableNumbersList" }, + "SearchContactFlowModules": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "non_aggregate_keys": [ + "ApproximateTotalCount" + ], + "output_token": "NextToken", + "result_key": "ContactFlowModules" + }, + "SearchContactFlows": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "non_aggregate_keys": [ + "ApproximateTotalCount" + ], + "output_token": "NextToken", + "result_key": "ContactFlows" + }, "SearchContacts": { "input_token": "NextToken", "limit_key": "MaxResults", diff --git a/models/apis/s3/2006-03-01/api-2.json b/models/apis/s3/2006-03-01/api-2.json index 45b0caf6683..a2405745d5c 100644 --- a/models/apis/s3/2006-03-01/api-2.json +++ b/models/apis/s3/2006-03-01/api-2.json @@ -6,6 +6,7 @@ "endpointPrefix":"s3", "globalEndpoint":"s3.amazonaws.com", "protocol":"rest-xml", + "protocols":["rest-xml"], "serviceAbbreviation":"Amazon S3", "serviceFullName":"Amazon Simple Storage Service", "serviceId":"S3", diff --git a/models/apis/s3/2006-03-01/examples-1.json b/models/apis/s3/2006-03-01/examples-1.json index f36dc25e35d..6f5e995e7db 100644 --- a/models/apis/s3/2006-03-01/examples-1.json +++ b/models/apis/s3/2006-03-01/examples-1.json @@ -257,10 +257,8 @@ "DeleteObject": [ { "input": { - "Bucket": "examplebucket", - "Key": "objectkey.jpg" - }, - "output": { + "Bucket": "ExampleBucket", + "Key": "HappyFace.jpg" }, "comments": { "input": { @@ -268,14 +266,16 @@ "output": { } }, - "description": "The following example deletes an object from an S3 bucket.", - "id": "to-delete-an-object-1472850136595", - "title": "To delete an object" + "description": "The following example deletes an object from a non-versioned bucket.", + "id": "to-delete-an-object-from-a-non-versioned-bucket-1481588533089", + "title": "To delete an object (from a non-versioned bucket)" }, { "input": { - "Bucket": "ExampleBucket", - "Key": "HappyFace.jpg" + "Bucket": "examplebucket", + "Key": "objectkey.jpg" + }, + "output": { }, "comments": { "input": { @@ -283,9 +283,9 @@ "output": { } }, - "description": "The following example deletes an object from a non-versioned bucket.", - "id": "to-delete-an-object-from-a-non-versioned-bucket-1481588533089", - "title": "To delete an object (from a non-versioned bucket)" + "description": "The following example deletes an object from an S3 bucket.", + "id": "to-delete-an-object-1472850136595", + "title": "To delete an object" } ], "DeleteObjectTagging": [ @@ -334,12 +334,10 @@ "Delete": { "Objects": [ { - "Key": "HappyFace.jpg", - "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b" + "Key": "objectkey1" }, { - "Key": "HappyFace.jpg", - "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd" + "Key": "objectkey2" } ], "Quiet": false @@ -348,12 +346,14 @@ "output": { "Deleted": [ { - "Key": "HappyFace.jpg", - "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd" + "DeleteMarker": "true", + "DeleteMarkerVersionId": "A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F", + "Key": "objectkey1" }, { - "Key": "HappyFace.jpg", - "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b" + "DeleteMarker": "true", + "DeleteMarkerVersionId": "iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt", + "Key": "objectkey2" } ] }, @@ -363,9 +363,9 @@ "output": { } }, - "description": "The following example deletes objects from a bucket. The request specifies object versions. S3 deletes specific object versions and returns the key and versions of deleted objects in the response.", - "id": "to-delete-multiple-object-versions-from-a-versioned-bucket-1483147087737", - "title": "To delete multiple object versions from a versioned bucket" + "description": "The following example deletes objects from a bucket. The bucket is versioned, and the request does not specify the object version to delete. In this case, all versions remain in the bucket and S3 adds a delete marker.", + "id": "to-delete-multiple-objects-from-a-versioned-bucket-1483146248805", + "title": "To delete multiple objects from a versioned bucket" }, { "input": { @@ -373,10 +373,12 @@ "Delete": { "Objects": [ { - "Key": "objectkey1" + "Key": "HappyFace.jpg", + "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b" }, { - "Key": "objectkey2" + "Key": "HappyFace.jpg", + "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd" } ], "Quiet": false @@ -385,14 +387,12 @@ "output": { "Deleted": [ { - "DeleteMarker": "true", - "DeleteMarkerVersionId": "A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F", - "Key": "objectkey1" + "Key": "HappyFace.jpg", + "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd" }, { - "DeleteMarker": "true", - "DeleteMarkerVersionId": "iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt", - "Key": "objectkey2" + "Key": "HappyFace.jpg", + "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b" } ] }, @@ -402,9 +402,9 @@ "output": { } }, - "description": "The following example deletes objects from a bucket. The bucket is versioned, and the request does not specify the object version to delete. In this case, all versions remain in the bucket and S3 adds a delete marker.", - "id": "to-delete-multiple-objects-from-a-versioned-bucket-1483146248805", - "title": "To delete multiple objects from a versioned bucket" + "description": "The following example deletes objects from a bucket. The request specifies object versions. S3 deletes specific object versions and returns the key and versions of deleted objects in the response.", + "id": "to-delete-multiple-object-versions-from-a-versioned-bucket-1483147087737", + "title": "To delete multiple object versions from a versioned bucket" } ], "GetBucketCors": [ @@ -840,17 +840,20 @@ { "input": { "Bucket": "examplebucket", - "Key": "exampleobject", - "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI" + "Key": "HappyFace.jpg" }, "output": { "TagSet": [ { - "Key": "Key1", - "Value": "Value1" + "Key": "Key4", + "Value": "Value4" + }, + { + "Key": "Key3", + "Value": "Value3" } ], - "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI" + "VersionId": "null" }, "comments": { "input": { @@ -858,27 +861,24 @@ "output": { } }, - "description": "The following example retrieves tag set of an object. The request specifies object version.", - "id": "to-retrieve-tag-set-of-a-specific-object-version-1483400283663", - "title": "To retrieve tag set of a specific object version" + "description": "The following example retrieves tag set of an object.", + "id": "to-retrieve-tag-set-of-an-object-1481833847896", + "title": "To retrieve tag set of an object" }, { "input": { "Bucket": "examplebucket", - "Key": "HappyFace.jpg" + "Key": "exampleobject", + "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI" }, "output": { "TagSet": [ { - "Key": "Key4", - "Value": "Value4" - }, - { - "Key": "Key3", - "Value": "Value3" + "Key": "Key1", + "Value": "Value1" } ], - "VersionId": "null" + "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI" }, "comments": { "input": { @@ -886,9 +886,9 @@ "output": { } }, - "description": "The following example retrieves tag set of an object.", - "id": "to-retrieve-tag-set-of-an-object-1481833847896", - "title": "To retrieve tag set of an object" + "description": "The following example retrieves tag set of an object. The request specifies object version.", + "id": "to-retrieve-tag-set-of-a-specific-object-version-1483400283663", + "title": "To retrieve tag set of a specific object version" } ], "GetObjectTorrent": [ @@ -1567,13 +1567,17 @@ "PutObject": [ { "input": { - "Body": "HappyFace.jpg", + "Body": "filetoupload", "Bucket": "examplebucket", - "Key": "HappyFace.jpg" + "Key": "exampleobject", + "Metadata": { + "metadata1": "value1", + "metadata2": "value2" + } }, "output": { "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", - "VersionId": "tpf3zF08nBplQK1XLOefGskR7mGDwcDk" + "VersionId": "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0" }, "comments": { "input": { @@ -1581,9 +1585,9 @@ "output": { } }, - "description": "The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file syntax. S3 returns VersionId of the newly created object.", - "id": "to-upload-an-object-1481760101010", - "title": "To upload an object" + "description": "The following example creates an object. The request also specifies optional metadata. If the bucket is versioning enabled, S3 returns version ID in response.", + "id": "to-upload-object-and-specify-user-defined-metadata-1483396974757", + "title": "To upload object and specify user-defined metadata" }, { "input": { @@ -1610,17 +1614,14 @@ }, { "input": { - "Body": "filetoupload", + "Body": "c:\\HappyFace.jpg", "Bucket": "examplebucket", - "Key": "exampleobject", - "Metadata": { - "metadata1": "value1", - "metadata2": "value2" - } + "Key": "HappyFace.jpg", + "Tagging": "key1=value1&key2=value2" }, "output": { "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", - "VersionId": "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0" + "VersionId": "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a" }, "comments": { "input": { @@ -1628,20 +1629,19 @@ "output": { } }, - "description": "The following example creates an object. The request also specifies optional metadata. If the bucket is versioning enabled, S3 returns version ID in response.", - "id": "to-upload-object-and-specify-user-defined-metadata-1483396974757", - "title": "To upload object and specify user-defined metadata" + "description": "The following example uploads an object. The request specifies optional object tags. The bucket is versioned, therefore S3 returns version ID of the newly created object.", + "id": "to-upload-an-object-and-specify-optional-tags-1481762310955", + "title": "To upload an object and specify optional tags" }, { "input": { - "ACL": "authenticated-read", "Body": "filetoupload", "Bucket": "examplebucket", - "Key": "exampleobject" + "Key": "objectkey" }, "output": { "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", - "VersionId": "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr" + "VersionId": "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ" }, "comments": { "input": { @@ -1649,19 +1649,19 @@ "output": { } }, - "description": "The following example uploads and object. The request specifies optional canned ACL (access control list) to all READ access to authenticated users. If the bucket is versioning enabled, S3 returns version ID in response.", - "id": "to-upload-an-object-and-specify-canned-acl-1483397779571", - "title": "To upload an object and specify canned ACL." + "description": "The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.", + "id": "to-create-an-object-1483147613675", + "title": "To create an object." }, { "input": { - "Body": "filetoupload", + "Body": "HappyFace.jpg", "Bucket": "examplebucket", - "Key": "objectkey" + "Key": "HappyFace.jpg" }, "output": { "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", - "VersionId": "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ" + "VersionId": "tpf3zF08nBplQK1XLOefGskR7mGDwcDk" }, "comments": { "input": { @@ -1669,22 +1669,20 @@ "output": { } }, - "description": "The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.", - "id": "to-create-an-object-1483147613675", - "title": "To create an object." + "description": "The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file syntax. S3 returns VersionId of the newly created object.", + "id": "to-upload-an-object-1481760101010", + "title": "To upload an object" }, { "input": { + "ACL": "authenticated-read", "Body": "filetoupload", "Bucket": "examplebucket", - "Key": "exampleobject", - "ServerSideEncryption": "AES256", - "Tagging": "key1=value1&key2=value2" + "Key": "exampleobject" }, "output": { "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", - "ServerSideEncryption": "AES256", - "VersionId": "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt" + "VersionId": "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr" }, "comments": { "input": { @@ -1692,20 +1690,22 @@ "output": { } }, - "description": "The following example uploads an object. The request specifies the optional server-side encryption option. The request also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response.", - "id": "to-upload-an-object-and-specify-server-side-encryption-and-object-tags-1483398331831", - "title": "To upload an object and specify server-side encryption and object tags" + "description": "The following example uploads and object. The request specifies optional canned ACL (access control list) to all READ access to authenticated users. If the bucket is versioning enabled, S3 returns version ID in response.", + "id": "to-upload-an-object-and-specify-canned-acl-1483397779571", + "title": "To upload an object and specify canned ACL." }, { "input": { - "Body": "c:\\HappyFace.jpg", + "Body": "filetoupload", "Bucket": "examplebucket", - "Key": "HappyFace.jpg", + "Key": "exampleobject", + "ServerSideEncryption": "AES256", "Tagging": "key1=value1&key2=value2" }, "output": { "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", - "VersionId": "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a" + "ServerSideEncryption": "AES256", + "VersionId": "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt" }, "comments": { "input": { @@ -1713,9 +1713,9 @@ "output": { } }, - "description": "The following example uploads an object. The request specifies optional object tags. The bucket is versioned, therefore S3 returns version ID of the newly created object.", - "id": "to-upload-an-object-and-specify-optional-tags-1481762310955", - "title": "To upload an object and specify optional tags" + "description": "The following example uploads an object. The request specifies the optional server-side encryption option. The request also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response.", + "id": "to-upload-an-object-and-specify-server-side-encryption-and-object-tags-1483398331831", + "title": "To upload an object and specify server-side encryption and object tags" } ], "PutObjectAcl": [ diff --git a/models/endpoints/endpoints.json b/models/endpoints/endpoints.json index 16dbbadf2dc..543def11af6 100644 --- a/models/endpoints/endpoints.json +++ b/models/endpoints/endpoints.json @@ -549,6 +549,7 @@ "ap-southeast-2" : { }, "eu-central-1" : { }, "eu-west-1" : { }, + "eu-west-2" : { }, "eu-west-3" : { }, "us-east-1" : { }, "us-east-2" : { }, diff --git a/service/connect/api.go b/service/connect/api.go index 6d79cf09285..6804bc3bd78 100644 --- a/service/connect/api.go +++ b/service/connect/api.go @@ -7186,6 +7186,15 @@ func (c *Connect) DescribeContactFlowRequest(input *DescribeContactFlowInput) (r // You can also create and update flows using the Amazon Connect Flow language // (https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html). // +// Use the $SAVED alias in the request to describe the SAVED content of a Flow. +// For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is +// published, $SAVED needs to be supplied to view saved content that has not +// been published. +// +// In the response, Status indicates the flow status as either SAVED or PUBLISHED. +// The PUBLISHED status will initiate validation on the content. SAVED does +// not initiate validation of the content. SAVED | PUBLISHED +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -7280,6 +7289,11 @@ func (c *Connect) DescribeContactFlowModuleRequest(input *DescribeContactFlowMod // // Describes the specified flow module. // +// Use the $SAVED alias in the request to describe the SAVED content of a Flow. +// For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is +// published, $SAVED needs to be supplied to view saved content that has not +// been published. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -19151,6 +19165,302 @@ func (c *Connect) SearchAvailablePhoneNumbersPagesWithContext(ctx aws.Context, i return p.Err() } +const opSearchContactFlowModules = "SearchContactFlowModules" + +// SearchContactFlowModulesRequest generates a "aws/request.Request" representing the +// client's request for the SearchContactFlowModules operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See SearchContactFlowModules for more information on using the SearchContactFlowModules +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the SearchContactFlowModulesRequest method. +// req, resp := client.SearchContactFlowModulesRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchContactFlowModules +func (c *Connect) SearchContactFlowModulesRequest(input *SearchContactFlowModulesInput) (req *request.Request, output *SearchContactFlowModulesOutput) { + op := &request.Operation{ + Name: opSearchContactFlowModules, + HTTPMethod: "POST", + HTTPPath: "/search-contact-flow-modules", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &SearchContactFlowModulesInput{} + } + + output = &SearchContactFlowModulesOutput{} + req = c.newRequest(op, input, output) + return +} + +// SearchContactFlowModules API operation for Amazon Connect Service. +// +// Searches the flow modules in an Amazon Connect instance, with optional filtering. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Connect Service's +// API operation SearchContactFlowModules for usage and error information. +// +// Returned Error Types: +// +// - InvalidRequestException +// The request is not valid. +// +// - InvalidParameterException +// One or more of the specified parameters are not valid. +// +// - ResourceNotFoundException +// The specified resource was not found. +// +// - ThrottlingException +// The throttling limit has been exceeded. +// +// - InternalServiceException +// Request processing failed because of an error or failure with the service. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchContactFlowModules +func (c *Connect) SearchContactFlowModules(input *SearchContactFlowModulesInput) (*SearchContactFlowModulesOutput, error) { + req, out := c.SearchContactFlowModulesRequest(input) + return out, req.Send() +} + +// SearchContactFlowModulesWithContext is the same as SearchContactFlowModules with the addition of +// the ability to pass a context and additional request options. +// +// See SearchContactFlowModules for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Connect) SearchContactFlowModulesWithContext(ctx aws.Context, input *SearchContactFlowModulesInput, opts ...request.Option) (*SearchContactFlowModulesOutput, error) { + req, out := c.SearchContactFlowModulesRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// SearchContactFlowModulesPages iterates over the pages of a SearchContactFlowModules operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See SearchContactFlowModules method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a SearchContactFlowModules operation. +// pageNum := 0 +// err := client.SearchContactFlowModulesPages(params, +// func(page *connect.SearchContactFlowModulesOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +func (c *Connect) SearchContactFlowModulesPages(input *SearchContactFlowModulesInput, fn func(*SearchContactFlowModulesOutput, bool) bool) error { + return c.SearchContactFlowModulesPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// SearchContactFlowModulesPagesWithContext same as SearchContactFlowModulesPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Connect) SearchContactFlowModulesPagesWithContext(ctx aws.Context, input *SearchContactFlowModulesInput, fn func(*SearchContactFlowModulesOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *SearchContactFlowModulesInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.SearchContactFlowModulesRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*SearchContactFlowModulesOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opSearchContactFlows = "SearchContactFlows" + +// SearchContactFlowsRequest generates a "aws/request.Request" representing the +// client's request for the SearchContactFlows operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See SearchContactFlows for more information on using the SearchContactFlows +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the SearchContactFlowsRequest method. +// req, resp := client.SearchContactFlowsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchContactFlows +func (c *Connect) SearchContactFlowsRequest(input *SearchContactFlowsInput) (req *request.Request, output *SearchContactFlowsOutput) { + op := &request.Operation{ + Name: opSearchContactFlows, + HTTPMethod: "POST", + HTTPPath: "/search-contact-flows", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &SearchContactFlowsInput{} + } + + output = &SearchContactFlowsOutput{} + req = c.newRequest(op, input, output) + return +} + +// SearchContactFlows API operation for Amazon Connect Service. +// +// Searches the contact flows in an Amazon Connect instance, with optional filtering. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Connect Service's +// API operation SearchContactFlows for usage and error information. +// +// Returned Error Types: +// +// - InvalidRequestException +// The request is not valid. +// +// - InvalidParameterException +// One or more of the specified parameters are not valid. +// +// - ResourceNotFoundException +// The specified resource was not found. +// +// - ThrottlingException +// The throttling limit has been exceeded. +// +// - InternalServiceException +// Request processing failed because of an error or failure with the service. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchContactFlows +func (c *Connect) SearchContactFlows(input *SearchContactFlowsInput) (*SearchContactFlowsOutput, error) { + req, out := c.SearchContactFlowsRequest(input) + return out, req.Send() +} + +// SearchContactFlowsWithContext is the same as SearchContactFlows with the addition of +// the ability to pass a context and additional request options. +// +// See SearchContactFlows for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Connect) SearchContactFlowsWithContext(ctx aws.Context, input *SearchContactFlowsInput, opts ...request.Option) (*SearchContactFlowsOutput, error) { + req, out := c.SearchContactFlowsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// SearchContactFlowsPages iterates over the pages of a SearchContactFlows operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See SearchContactFlows method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a SearchContactFlows operation. +// pageNum := 0 +// err := client.SearchContactFlowsPages(params, +// func(page *connect.SearchContactFlowsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +func (c *Connect) SearchContactFlowsPages(input *SearchContactFlowsInput, fn func(*SearchContactFlowsOutput, bool) bool) error { + return c.SearchContactFlowsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// SearchContactFlowsPagesWithContext same as SearchContactFlowsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Connect) SearchContactFlowsPagesWithContext(ctx aws.Context, input *SearchContactFlowsInput, fn func(*SearchContactFlowsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *SearchContactFlowsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.SearchContactFlowsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*SearchContactFlowsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opSearchContacts = "SearchContacts" // SearchContactsRequest generates a "aws/request.Request" representing the @@ -23156,6 +23466,11 @@ func (c *Connect) UpdateContactFlowContentRequest(input *UpdateContactFlowConten // You can also create and update flows using the Amazon Connect Flow language // (https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html). // +// Use the $SAVED alias in the request to describe the SAVED content of a Flow. +// For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is +// published, $SAVED needs to be supplied to view saved content that has not +// been published. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -23346,6 +23661,11 @@ func (c *Connect) UpdateContactFlowModuleContentRequest(input *UpdateContactFlow // // Updates specified flow module for the specified Amazon Connect instance. // +// Use the $SAVED alias in the request to describe the SAVED content of a Flow. +// For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is +// published, $SAVED needs to be supplied to view saved content that has not +// been published. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -32000,6 +32320,9 @@ type ContactFlow struct { // The type of flow. State *string `type:"string" enum:"ContactFlowState"` + // The status of the contact flow. + Status *string `type:"string" enum:"ContactFlowStatus"` + // The tags used to organize, track, or control access for this resource. For // example, { "Tags": {"key1":"value1", "key2":"value2"} }. Tags map[string]*string `min:"1" type:"map"` @@ -32064,6 +32387,12 @@ func (s *ContactFlow) SetState(v string) *ContactFlow { return s } +// SetStatus sets the Status field's value. +func (s *ContactFlow) SetStatus(v string) *ContactFlow { + s.Status = &v + return s +} + // SetTags sets the Tags field's value. func (s *ContactFlow) SetTags(v map[string]*string) *ContactFlow { s.Tags = v @@ -32173,6 +32502,96 @@ func (s *ContactFlowModule) SetTags(v map[string]*string) *ContactFlowModule { return s } +// The search criteria to be used to return flow modules. +type ContactFlowModuleSearchCriteria struct { + _ struct{} `type:"structure"` + + // A list of conditions which would be applied together with an AND condition. + AndConditions []*ContactFlowModuleSearchCriteria `type:"list"` + + // A list of conditions which would be applied together with an OR condition. + OrConditions []*ContactFlowModuleSearchCriteria `type:"list"` + + // A leaf node condition which can be used to specify a string condition. + // + // The currently supported values for FieldName are name and description. + StringCondition *StringCondition `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ContactFlowModuleSearchCriteria) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ContactFlowModuleSearchCriteria) GoString() string { + return s.String() +} + +// SetAndConditions sets the AndConditions field's value. +func (s *ContactFlowModuleSearchCriteria) SetAndConditions(v []*ContactFlowModuleSearchCriteria) *ContactFlowModuleSearchCriteria { + s.AndConditions = v + return s +} + +// SetOrConditions sets the OrConditions field's value. +func (s *ContactFlowModuleSearchCriteria) SetOrConditions(v []*ContactFlowModuleSearchCriteria) *ContactFlowModuleSearchCriteria { + s.OrConditions = v + return s +} + +// SetStringCondition sets the StringCondition field's value. +func (s *ContactFlowModuleSearchCriteria) SetStringCondition(v *StringCondition) *ContactFlowModuleSearchCriteria { + s.StringCondition = v + return s +} + +// The search criteria to be used to return flow modules. +type ContactFlowModuleSearchFilter struct { + _ struct{} `type:"structure"` + + // An object that can be used to specify Tag conditions inside the SearchFilter. + // This accepts an OR of AND (List of List) input where: + // + // * Top level list specifies conditions that need to be applied with OR + // operator + // + // * Inner list specifies conditions that need to be applied with AND operator. + TagFilter *ControlPlaneTagFilter `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ContactFlowModuleSearchFilter) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ContactFlowModuleSearchFilter) GoString() string { + return s.String() +} + +// SetTagFilter sets the TagFilter field's value. +func (s *ContactFlowModuleSearchFilter) SetTagFilter(v *ControlPlaneTagFilter) *ContactFlowModuleSearchFilter { + s.TagFilter = v + return s +} + // Contains summary information about a flow. type ContactFlowModuleSummary struct { _ struct{} `type:"structure"` @@ -32296,6 +32715,123 @@ func (s *ContactFlowNotPublishedException) RequestID() string { return s.RespMetadata.RequestID } +// The search criteria to be used to return contact flows. +type ContactFlowSearchCriteria struct { + _ struct{} `type:"structure"` + + // A list of conditions which would be applied together with an AND condition. + AndConditions []*ContactFlowSearchCriteria `type:"list"` + + // A list of conditions which would be applied together with an OR condition. + OrConditions []*ContactFlowSearchCriteria `type:"list"` + + // The state of the flow. + StateCondition *string `type:"string" enum:"ContactFlowState"` + + // The status of the flow. + StatusCondition *string `type:"string" enum:"ContactFlowStatus"` + + // A leaf node condition which can be used to specify a string condition. + // + // The currently supported values for FieldName are name and description. + StringCondition *StringCondition `type:"structure"` + + // The type of flow. + TypeCondition *string `type:"string" enum:"ContactFlowType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ContactFlowSearchCriteria) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ContactFlowSearchCriteria) GoString() string { + return s.String() +} + +// SetAndConditions sets the AndConditions field's value. +func (s *ContactFlowSearchCriteria) SetAndConditions(v []*ContactFlowSearchCriteria) *ContactFlowSearchCriteria { + s.AndConditions = v + return s +} + +// SetOrConditions sets the OrConditions field's value. +func (s *ContactFlowSearchCriteria) SetOrConditions(v []*ContactFlowSearchCriteria) *ContactFlowSearchCriteria { + s.OrConditions = v + return s +} + +// SetStateCondition sets the StateCondition field's value. +func (s *ContactFlowSearchCriteria) SetStateCondition(v string) *ContactFlowSearchCriteria { + s.StateCondition = &v + return s +} + +// SetStatusCondition sets the StatusCondition field's value. +func (s *ContactFlowSearchCriteria) SetStatusCondition(v string) *ContactFlowSearchCriteria { + s.StatusCondition = &v + return s +} + +// SetStringCondition sets the StringCondition field's value. +func (s *ContactFlowSearchCriteria) SetStringCondition(v *StringCondition) *ContactFlowSearchCriteria { + s.StringCondition = v + return s +} + +// SetTypeCondition sets the TypeCondition field's value. +func (s *ContactFlowSearchCriteria) SetTypeCondition(v string) *ContactFlowSearchCriteria { + s.TypeCondition = &v + return s +} + +// Filters to be applied to search results. +type ContactFlowSearchFilter struct { + _ struct{} `type:"structure"` + + // An object that can be used to specify Tag conditions inside the SearchFilter. + // This accepts an OR of AND (List of List) input where: + // + // * Top level list specifies conditions that need to be applied with OR + // operator + // + // * Inner list specifies conditions that need to be applied with AND operator. + TagFilter *ControlPlaneTagFilter `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ContactFlowSearchFilter) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ContactFlowSearchFilter) GoString() string { + return s.String() +} + +// SetTagFilter sets the TagFilter field's value. +func (s *ContactFlowSearchFilter) SetTagFilter(v *ControlPlaneTagFilter) *ContactFlowSearchFilter { + s.TagFilter = v + return s +} + // Contains summary information about a flow. // // You can also create and update flows using the Amazon Connect Flow language @@ -32309,6 +32845,9 @@ type ContactFlowSummary struct { // The type of flow. ContactFlowState *string `type:"string" enum:"ContactFlowState"` + // The status of the contact flow. + ContactFlowStatus *string `type:"string" enum:"ContactFlowStatus"` + // The type of flow. ContactFlowType *string `type:"string" enum:"ContactFlowType"` @@ -32349,6 +32888,12 @@ func (s *ContactFlowSummary) SetContactFlowState(v string) *ContactFlowSummary { return s } +// SetContactFlowStatus sets the ContactFlowStatus field's value. +func (s *ContactFlowSummary) SetContactFlowStatus(v string) *ContactFlowSummary { + s.ContactFlowStatus = &v + return s +} + // SetContactFlowType sets the ContactFlowType field's value. func (s *ContactFlowSummary) SetContactFlowType(v string) *ContactFlowSummary { s.ContactFlowType = &v @@ -33031,6 +33576,11 @@ type CreateContactFlowInput struct { // Name is a required field Name *string `min:"1" type:"string" required:"true"` + // Indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED status + // will initiate validation on the content. the SAVED status does not initiate + // validation of the content. SAVED | PUBLISHED. + Status *string `type:"string" enum:"ContactFlowStatus"` + // The tags used to organize, track, or control access for this resource. For // example, { "Tags": {"key1":"value1", "key2":"value2"} }. Tags map[string]*string `min:"1" type:"map"` @@ -33116,6 +33666,12 @@ func (s *CreateContactFlowInput) SetName(v string) *CreateContactFlowInput { return s } +// SetStatus sets the Status field's value. +func (s *CreateContactFlowInput) SetStatus(v string) *CreateContactFlowInput { + s.Status = &v + return s +} + // SetTags sets the Tags field's value. func (s *CreateContactFlowInput) SetTags(v map[string]*string) *CreateContactFlowInput { s.Tags = v @@ -46365,7 +46921,8 @@ type GetAttachedFileInput struct { // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` - // Optional override for the expiry of the pre-signed S3 URL in seconds. + // Optional override for the expiry of the pre-signed S3 URL in seconds. The + // default value is 300. UrlExpiryInSeconds *int64 `location:"querystring" locationName:"urlExpiryInSeconds" min:"5" type:"integer"` } @@ -46445,8 +47002,6 @@ type GetAttachedFileOutput struct { // The resource to which the attached file is (being) uploaded to. Cases (https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateCase.html) // are the only current supported resource. - // - // This value must be a valid ARN. AssociatedResourceArn *string `type:"string"` // Represents the identity that created the file. @@ -47813,6 +48368,7 @@ type GetMetricDataV2Input struct { // | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR // | AGENT_HIERARCHY_LEVEL_FIVE | FEATURE | CASE_TEMPLATE_ARN | CASE_STATUS // | contact/segmentAttributes/connect:Subtype | ROUTING_STEP_EXPRESSION + // | Q_CONNECT_ENABLED // // * Filter values: A maximum of 100 filter values are supported in a single // request. VOICE, CHAT, and TASK are valid filterValue for the CHANNEL filter @@ -47826,7 +48382,12 @@ type GetMetricDataV2Input struct { // the contact/segmentAttributes/connect:Subtype filter key. ROUTING_STEP_EXPRESSION // is a valid filter key with a filter value up to 3000 length. This filter // is case and order sensitive. JSON string fields must be sorted in ascending - // order and JSON array order should be kept as is. + // order and JSON array order should be kept as is. Q_CONNECT_ENABLED. TRUE + // and FALSE are the only valid filterValues for the Q_CONNECT_ENABLED filter + // key. TRUE includes all contacts that had Amazon Q in Connect enabled as + // part of the flow. FALSE includes all contacts that did not have Amazon + // Q in Connect enabled as part of the flow This filter is available only + // for contact record-driven metrics. // // Filters is a required field Filters []*FilterV2 `min:"1" type:"list" required:"true"` @@ -47841,7 +48402,7 @@ type GetMetricDataV2Input struct { // Valid grouping keys: QUEUE | ROUTING_PROFILE | AGENT | CHANNEL | AGENT_HIERARCHY_LEVEL_ONE // | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR // | AGENT_HIERARCHY_LEVEL_FIVE | CASE_TEMPLATE_ARN | CASE_STATUS | contact/segmentAttributes/connect:Subtype - // | ROUTING_STEP_EXPRESSION + // | ROUTING_STEP_EXPRESSION | Q_CONNECT_ENABLED Groupings []*string `type:"list"` // The interval period and timezone to apply to returned metrics. @@ -47877,7 +48438,7 @@ type GetMetricDataV2Input struct { // Unit: Percent // // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy, Feature, contact/segmentAttributes/connect:Subtype + // Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect // // UI name: Abandonment rate (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#abandonment-rate-historical) // @@ -47971,7 +48532,7 @@ type GetMetricDataV2Input struct { // Unit: Seconds // // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy, Feature, contact/segmentAttributes/connect:Subtype + // Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect // // UI name: Average queue abandon time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-queue-abandon-time-historical) // @@ -47980,7 +48541,7 @@ type GetMetricDataV2Input struct { // Unit: Seconds // // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy + // Hierarchy, Q in Connect // // UI name: Average active time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-active-time-historical) // @@ -47991,7 +48552,7 @@ type GetMetricDataV2Input struct { // Valid metric filter key: INITIATION_METHOD // // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy, Feature, contact/segmentAttributes/connect:Subtype + // Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect // // UI name: Average after contact work time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-acw-time-historical) // @@ -48016,7 +48577,7 @@ type GetMetricDataV2Input struct { // Unit: Seconds // // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy + // Hierarchy, Q in Connect // // UI name: Average agent pause time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-agent-pause-time-historical) // @@ -48045,7 +48606,7 @@ type GetMetricDataV2Input struct { // Unit: Seconds // // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy, Feature, contact/segmentAttributes/connect:Subtype + // Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect // // UI name: Average contact duration (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-contact-duration-historical) // @@ -48056,7 +48617,7 @@ type GetMetricDataV2Input struct { // Unit: Seconds // // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy, Feature, contact/segmentAttributes/connect:Subtype + // Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect // // UI name: Average conversation duration (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-conversation-duration-historical) // @@ -48068,7 +48629,7 @@ type GetMetricDataV2Input struct { // Unit: Seconds // // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy, contact/segmentAttributes/connect:Subtype + // Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect // // UI name: Average agent greeting time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-greeting-time-agent-historical) // @@ -48088,7 +48649,7 @@ type GetMetricDataV2Input struct { // Unit: Seconds // // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy, Feature, contact/segmentAttributes/connect:Subtype + // Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect // // UI name: Average customer hold time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-customer-hold-time-historical) // @@ -48099,7 +48660,7 @@ type GetMetricDataV2Input struct { // Unit: Seconds // // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy, contact/segmentAttributes/connect:Subtype + // Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect // // UI name: Average customer hold time all contacts (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#avg-customer-hold-time-all-contacts-historical) // @@ -48108,7 +48669,7 @@ type GetMetricDataV2Input struct { // Unit: Count // // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy, Feature, contact/segmentAttributes/connect:Subtype + // Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect // // UI name: Average holds (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-holds-historical) // @@ -48119,7 +48680,7 @@ type GetMetricDataV2Input struct { // Unit: Seconds // // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy, contact/segmentAttributes/connect:Subtype + // Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect // // UI name: Average agent interaction and customer hold time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-agent-interaction-customer-hold-time-historical) // @@ -48129,7 +48690,8 @@ type GetMetricDataV2Input struct { // // Valid metric filter key: INITIATION_METHOD // - // Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype + // Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, + // Q in Connect // // UI name: Average agent interaction time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-agent-interaction-time-historical) // @@ -48143,7 +48705,7 @@ type GetMetricDataV2Input struct { // Unit: Count // // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy, contact/segmentAttributes/connect:Subtype + // Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect // // UI name: Average agent interruptions (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-interruptions-agent-historical) // @@ -48155,7 +48717,7 @@ type GetMetricDataV2Input struct { // Unit: Seconds // // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy, contact/segmentAttributes/connect:Subtype + // Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect // // UI name: Average agent interruption time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-interruptions-time-agent-historical) // @@ -48167,7 +48729,7 @@ type GetMetricDataV2Input struct { // Unit: Seconds // // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy, contact/segmentAttributes/connect:Subtype + // Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect // // UI name: Average non-talk time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html##average-non-talk-time-historical) // @@ -48175,7 +48737,8 @@ type GetMetricDataV2Input struct { // // Unit: Seconds // - // Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype + // Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, + // Q in Connect // // UI name: Average queue answer time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-queue-answer-time-historical) // @@ -48185,7 +48748,8 @@ type GetMetricDataV2Input struct { // // Unit: Seconds // - // Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype + // Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, + // Q in Connect // // UI name: Average resolution time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-resolution-time-historical) // @@ -48197,7 +48761,7 @@ type GetMetricDataV2Input struct { // Unit: Seconds // // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy, contact/segmentAttributes/connect:Subtype + // Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect // // UI name: Average talk time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-talk-time-historical) // @@ -48209,7 +48773,7 @@ type GetMetricDataV2Input struct { // Unit: Seconds // // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy, contact/segmentAttributes/connect:Subtype + // Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect // // UI name: Average agent talk time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-talk-time-agent-historical) // @@ -48221,7 +48785,7 @@ type GetMetricDataV2Input struct { // Unit: Seconds // // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy, contact/segmentAttributes/connect:Subtype + // Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect // // UI name: Average customer talk time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-talk-time-customer-historical) // @@ -48240,7 +48804,8 @@ type GetMetricDataV2Input struct { // Unit: Count // // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression + // Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, + // Q in Connect // // UI name: Contact abandoned (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-abandoned-historical) // @@ -48250,7 +48815,8 @@ type GetMetricDataV2Input struct { // // Valid metric filter key: INITIATION_METHOD // - // Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype + // Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, + // Q in Connect // // UI name: Contacts created (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-created-historical) // @@ -48263,7 +48829,8 @@ type GetMetricDataV2Input struct { // Valid metric filter key: INITIATION_METHOD, DISCONNECT_REASON // // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression + // Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, + // Q in Connect // // UI name: API contacts handled (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#api-contacts-handled-historical) // @@ -48275,7 +48842,8 @@ type GetMetricDataV2Input struct { // // Valid metric filter key: INITIATION_METHOD // - // Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype + // Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, + // Q in Connect // // UI name: Contacts handled (connected to agent timestamp) (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-handled-by-connected-to-agent-historical) // @@ -48284,7 +48852,7 @@ type GetMetricDataV2Input struct { // Unit: Count // // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy, contact/segmentAttributes/connect:Subtype + // Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect // // UI name: Contacts hold disconnect (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-handled-by-connected-to-agent-historical) // @@ -48293,7 +48861,7 @@ type GetMetricDataV2Input struct { // Unit: Count // // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy + // Hierarchy, Q in Connect // // UI name: Contacts hold agent disconnect (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-hold-agent-disconnect-historical) // @@ -48302,7 +48870,7 @@ type GetMetricDataV2Input struct { // Unit: Count // // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy + // Hierarchy, Q in Connect // // UI name: Contacts hold customer disconnect (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-hold-customer-disconnect-historical) // @@ -48311,7 +48879,7 @@ type GetMetricDataV2Input struct { // Unit: Count // // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy + // Hierarchy, Q in Connect // // UI name: Contacts put on hold (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-hold-customer-disconnect-historical) // @@ -48320,7 +48888,7 @@ type GetMetricDataV2Input struct { // Unit: Count // // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy + // Hierarchy, Q in Connect // // UI name: Contacts transferred out external (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-external-historical) // @@ -48329,7 +48897,7 @@ type GetMetricDataV2Input struct { // Unit: Percent // // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy + // Hierarchy, Q in Connect // // UI name: Contacts transferred out internal (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-internal-historical) // @@ -48338,7 +48906,7 @@ type GetMetricDataV2Input struct { // Unit: Count // // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy, contact/segmentAttributes/connect:Subtype + // Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect // // UI name: Contacts queued (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-queued-historical) // @@ -48354,7 +48922,8 @@ type GetMetricDataV2Input struct { // // Unit: Count // - // Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype + // Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, + // Q in Connect // // Threshold: For ThresholdValue enter any whole number from 1 to 604800 (inclusive), // in seconds. For Comparison, you must enter LT (for "Less than"). @@ -48366,7 +48935,7 @@ type GetMetricDataV2Input struct { // Unit: Count // // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy, Feature, contact/segmentAttributes/connect:Subtype + // Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect // // UI name: Contacts transferred out (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-historical) // @@ -48377,7 +48946,7 @@ type GetMetricDataV2Input struct { // Unit: Count // // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy, contact/segmentAttributes/connect:Subtype + // Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect // // UI name: Contacts transferred out by agent (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-by-agent-historical) // @@ -48386,7 +48955,7 @@ type GetMetricDataV2Input struct { // Unit: Count // // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy, contact/segmentAttributes/connect:Subtype + // Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect // // UI name: Contacts transferred out queue (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-by-agent-historical) // @@ -48405,7 +48974,7 @@ type GetMetricDataV2Input struct { // Unit: Seconds // // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy, contact/segmentAttributes/connect:Subtype + // Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect // // UI name: Maximum queued time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#maximum-queued-time-historical) // @@ -48443,7 +49012,7 @@ type GetMetricDataV2Input struct { // Unit: Percentage // // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy, contact/segmentAttributes/connect:Subtype + // Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect // // UI name: Non-talk time percent (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#ntt-historical) // @@ -48455,7 +49024,7 @@ type GetMetricDataV2Input struct { // Unit: Percentage // // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy, contact/segmentAttributes/connect:Subtype + // Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect // // UI name: Talk time percent (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#tt-historical) // @@ -48467,7 +49036,7 @@ type GetMetricDataV2Input struct { // Unit: Percentage // // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy, contact/segmentAttributes/connect:Subtype + // Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect // // UI name: Agent talk time percent (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#ttagent-historical) // @@ -48479,7 +49048,7 @@ type GetMetricDataV2Input struct { // Unit: Percentage // // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy, contact/segmentAttributes/connect:Subtype + // Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect // // UI name: Customer talk time percent (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#ttcustomer-historical) // @@ -48509,7 +49078,7 @@ type GetMetricDataV2Input struct { // // Unit: Percent // - // Valid groupings and filters: Queue, Channel, Routing Profile + // Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect // // Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), // in seconds. For Comparison, you must enter LT (for "Less than"). @@ -48529,7 +49098,7 @@ type GetMetricDataV2Input struct { // Unit: Seconds // // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy + // Hierarchy, Q in Connect // // UI name: After contact work time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#acw-historical) // @@ -48553,7 +49122,7 @@ type GetMetricDataV2Input struct { // Unit: Seconds // // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy + // Hierarchy, Q in Connect // // UI name: Contact flow time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contact-flow-time-historical) // @@ -48570,7 +49139,8 @@ type GetMetricDataV2Input struct { // // Unit: Count // - // Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype + // Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, + // Q in Connect // // Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), // in seconds. For Comparison, you must enter LT (for "Less than"). @@ -48581,7 +49151,8 @@ type GetMetricDataV2Input struct { // // Unit: Count // - // Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype + // Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, + // Q in Connect // // Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), // in seconds. For Comparison, you must enter LT (for "Less than"). @@ -48595,7 +49166,7 @@ type GetMetricDataV2Input struct { // Unit: Count // // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy, contact/segmentAttributes/connect:Subtype + // Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect // // UI name: Contact disconnected (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contact-disconnected-historical) // @@ -48613,7 +49184,7 @@ type GetMetricDataV2Input struct { // Unit: Seconds // // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy + // Hierarchy, Q in Connect // // UI name: Contact handle time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contact-handle-time-historical) // @@ -48622,7 +49193,7 @@ type GetMetricDataV2Input struct { // Unit: Count // // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy + // Hierarchy, Q in Connect // // UI name: Customer hold time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#customer-hold-time-historical) // @@ -48639,7 +49210,7 @@ type GetMetricDataV2Input struct { // Unit: Seconds // // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy + // Hierarchy, Q in Connect // // UI name: Agent interaction and hold time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-interaction-hold-time-historical) // @@ -48672,7 +49243,8 @@ type GetMetricDataV2Input struct { // // Unit: Count // - // Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype + // Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, + // Q in Connect // // UI name: Callback attempts (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#callback-attempts-historical) // @@ -64267,6 +64839,298 @@ func (s *SearchAvailablePhoneNumbersOutput) SetNextToken(v string) *SearchAvaila return s } +type SearchContactFlowModulesInput struct { + _ struct{} `type:"structure"` + + // The identifier of the Amazon Connect instance. You can find the instance + // ID in the Amazon Resource Name (ARN) of the instance. + // + // InstanceId is a required field + InstanceId *string `min:"1" type:"string" required:"true"` + + // The maximum number of results to return per page. + MaxResults *int64 `min:"1" type:"integer"` + + // The token for the next set of results. Use the value returned in the previous + // response in the next request to retrieve the next set of results. + NextToken *string `min:"1" type:"string"` + + // The search criteria to be used to return contact flow modules. + // + // The name and description fields support "contains" queries with a minimum + // of 2 characters and a maximum of 25 characters. Any queries with character + // lengths outside of this range will result in invalid results. + SearchCriteria *ContactFlowModuleSearchCriteria `type:"structure"` + + // Filters to be applied to search results. + SearchFilter *ContactFlowModuleSearchFilter `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SearchContactFlowModulesInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SearchContactFlowModulesInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *SearchContactFlowModulesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "SearchContactFlowModulesInput"} + if s.InstanceId == nil { + invalidParams.Add(request.NewErrParamRequired("InstanceId")) + } + if s.InstanceId != nil && len(*s.InstanceId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("InstanceId", 1)) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetInstanceId sets the InstanceId field's value. +func (s *SearchContactFlowModulesInput) SetInstanceId(v string) *SearchContactFlowModulesInput { + s.InstanceId = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *SearchContactFlowModulesInput) SetMaxResults(v int64) *SearchContactFlowModulesInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *SearchContactFlowModulesInput) SetNextToken(v string) *SearchContactFlowModulesInput { + s.NextToken = &v + return s +} + +// SetSearchCriteria sets the SearchCriteria field's value. +func (s *SearchContactFlowModulesInput) SetSearchCriteria(v *ContactFlowModuleSearchCriteria) *SearchContactFlowModulesInput { + s.SearchCriteria = v + return s +} + +// SetSearchFilter sets the SearchFilter field's value. +func (s *SearchContactFlowModulesInput) SetSearchFilter(v *ContactFlowModuleSearchFilter) *SearchContactFlowModulesInput { + s.SearchFilter = v + return s +} + +type SearchContactFlowModulesOutput struct { + _ struct{} `type:"structure"` + + // The total number of contact flows which matched your search query. + ApproximateTotalCount *int64 `type:"long"` + + // The search criteria to be used to return contact flow modules. + ContactFlowModules []*ContactFlowModule `type:"list"` + + // If there are additional results, this is the token for the next set of results. + NextToken *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SearchContactFlowModulesOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SearchContactFlowModulesOutput) GoString() string { + return s.String() +} + +// SetApproximateTotalCount sets the ApproximateTotalCount field's value. +func (s *SearchContactFlowModulesOutput) SetApproximateTotalCount(v int64) *SearchContactFlowModulesOutput { + s.ApproximateTotalCount = &v + return s +} + +// SetContactFlowModules sets the ContactFlowModules field's value. +func (s *SearchContactFlowModulesOutput) SetContactFlowModules(v []*ContactFlowModule) *SearchContactFlowModulesOutput { + s.ContactFlowModules = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *SearchContactFlowModulesOutput) SetNextToken(v string) *SearchContactFlowModulesOutput { + s.NextToken = &v + return s +} + +type SearchContactFlowsInput struct { + _ struct{} `type:"structure"` + + // The identifier of the Amazon Connect instance. You can find the instance + // ID in the Amazon Resource Name (ARN) of the instance. + // + // InstanceId is a required field + InstanceId *string `min:"1" type:"string" required:"true"` + + // The maximum number of results to return per page. + MaxResults *int64 `min:"1" type:"integer"` + + // The token for the next set of results. Use the value returned in the previous + // response in the next request to retrieve the next set of results. + NextToken *string `min:"1" type:"string"` + + // The search criteria to be used to return flows. + // + // The name and description fields support "contains" queries with a minimum + // of 2 characters and a maximum of 25 characters. Any queries with character + // lengths outside of this range will result in invalid results. + SearchCriteria *ContactFlowSearchCriteria `type:"structure"` + + // Filters to be applied to search results. + SearchFilter *ContactFlowSearchFilter `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SearchContactFlowsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SearchContactFlowsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *SearchContactFlowsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "SearchContactFlowsInput"} + if s.InstanceId == nil { + invalidParams.Add(request.NewErrParamRequired("InstanceId")) + } + if s.InstanceId != nil && len(*s.InstanceId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("InstanceId", 1)) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetInstanceId sets the InstanceId field's value. +func (s *SearchContactFlowsInput) SetInstanceId(v string) *SearchContactFlowsInput { + s.InstanceId = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *SearchContactFlowsInput) SetMaxResults(v int64) *SearchContactFlowsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *SearchContactFlowsInput) SetNextToken(v string) *SearchContactFlowsInput { + s.NextToken = &v + return s +} + +// SetSearchCriteria sets the SearchCriteria field's value. +func (s *SearchContactFlowsInput) SetSearchCriteria(v *ContactFlowSearchCriteria) *SearchContactFlowsInput { + s.SearchCriteria = v + return s +} + +// SetSearchFilter sets the SearchFilter field's value. +func (s *SearchContactFlowsInput) SetSearchFilter(v *ContactFlowSearchFilter) *SearchContactFlowsInput { + s.SearchFilter = v + return s +} + +type SearchContactFlowsOutput struct { + _ struct{} `type:"structure"` + + // The total number of contact flows which matched your search query. + ApproximateTotalCount *int64 `type:"long"` + + // Information about the contact flows. + ContactFlows []*ContactFlow `type:"list"` + + // If there are additional results, this is the token for the next set of results. + NextToken *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SearchContactFlowsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SearchContactFlowsOutput) GoString() string { + return s.String() +} + +// SetApproximateTotalCount sets the ApproximateTotalCount field's value. +func (s *SearchContactFlowsOutput) SetApproximateTotalCount(v int64) *SearchContactFlowsOutput { + s.ApproximateTotalCount = &v + return s +} + +// SetContactFlows sets the ContactFlows field's value. +func (s *SearchContactFlowsOutput) SetContactFlows(v []*ContactFlow) *SearchContactFlowsOutput { + s.ContactFlows = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *SearchContactFlowsOutput) SetNextToken(v string) *SearchContactFlowsOutput { + s.NextToken = &v + return s +} + type SearchContactsInput struct { _ struct{} `type:"structure"` @@ -67321,7 +68185,8 @@ type StartAttachedFileUploadInput struct { // example, { "Tags": {"key1":"value1", "key2":"value2"} }. Tags map[string]*string `min:"1" type:"map"` - // Optional override for the expiry of the pre-signed S3 URL in seconds. + // Optional override for the expiry of the pre-signed S3 URL in seconds. The + // default value is 300. UrlExpiryInSeconds *int64 `min:"5" type:"integer"` } @@ -79616,6 +80481,22 @@ func ContactFlowState_Values() []string { } } +const ( + // ContactFlowStatusPublished is a ContactFlowStatus enum value + ContactFlowStatusPublished = "PUBLISHED" + + // ContactFlowStatusSaved is a ContactFlowStatus enum value + ContactFlowStatusSaved = "SAVED" +) + +// ContactFlowStatus_Values returns all elements of the ContactFlowStatus enum +func ContactFlowStatus_Values() []string { + return []string{ + ContactFlowStatusPublished, + ContactFlowStatusSaved, + } +} + const ( // ContactFlowTypeContactFlow is a ContactFlowType enum value ContactFlowTypeContactFlow = "CONTACT_FLOW" diff --git a/service/connect/connectiface/interface.go b/service/connect/connectiface/interface.go index 4f0c7e5b2db..d796b294b8e 100644 --- a/service/connect/connectiface/interface.go +++ b/service/connect/connectiface/interface.go @@ -889,6 +889,20 @@ type ConnectAPI interface { SearchAvailablePhoneNumbersPages(*connect.SearchAvailablePhoneNumbersInput, func(*connect.SearchAvailablePhoneNumbersOutput, bool) bool) error SearchAvailablePhoneNumbersPagesWithContext(aws.Context, *connect.SearchAvailablePhoneNumbersInput, func(*connect.SearchAvailablePhoneNumbersOutput, bool) bool, ...request.Option) error + SearchContactFlowModules(*connect.SearchContactFlowModulesInput) (*connect.SearchContactFlowModulesOutput, error) + SearchContactFlowModulesWithContext(aws.Context, *connect.SearchContactFlowModulesInput, ...request.Option) (*connect.SearchContactFlowModulesOutput, error) + SearchContactFlowModulesRequest(*connect.SearchContactFlowModulesInput) (*request.Request, *connect.SearchContactFlowModulesOutput) + + SearchContactFlowModulesPages(*connect.SearchContactFlowModulesInput, func(*connect.SearchContactFlowModulesOutput, bool) bool) error + SearchContactFlowModulesPagesWithContext(aws.Context, *connect.SearchContactFlowModulesInput, func(*connect.SearchContactFlowModulesOutput, bool) bool, ...request.Option) error + + SearchContactFlows(*connect.SearchContactFlowsInput) (*connect.SearchContactFlowsOutput, error) + SearchContactFlowsWithContext(aws.Context, *connect.SearchContactFlowsInput, ...request.Option) (*connect.SearchContactFlowsOutput, error) + SearchContactFlowsRequest(*connect.SearchContactFlowsInput) (*request.Request, *connect.SearchContactFlowsOutput) + + SearchContactFlowsPages(*connect.SearchContactFlowsInput, func(*connect.SearchContactFlowsOutput, bool) bool) error + SearchContactFlowsPagesWithContext(aws.Context, *connect.SearchContactFlowsInput, func(*connect.SearchContactFlowsOutput, bool) bool, ...request.Option) error + SearchContacts(*connect.SearchContactsInput) (*connect.SearchContactsOutput, error) SearchContactsWithContext(aws.Context, *connect.SearchContactsInput, ...request.Option) (*connect.SearchContactsOutput, error) SearchContactsRequest(*connect.SearchContactsInput) (*request.Request, *connect.SearchContactsOutput) diff --git a/service/s3/examples_test.go b/service/s3/examples_test.go index 31e135b9561..791e978e3c2 100644 --- a/service/s3/examples_test.go +++ b/service/s3/examples_test.go @@ -398,13 +398,13 @@ func ExampleS3_DeleteBucketWebsite_shared00() { fmt.Println(result) } -// To delete an object -// The following example deletes an object from an S3 bucket. +// To delete an object (from a non-versioned bucket) +// The following example deletes an object from a non-versioned bucket. func ExampleS3_DeleteObject_shared00() { svc := s3.New(session.New()) input := &s3.DeleteObjectInput{ - Bucket: aws.String("examplebucket"), - Key: aws.String("objectkey.jpg"), + Bucket: aws.String("ExampleBucket"), + Key: aws.String("HappyFace.jpg"), } result, err := svc.DeleteObject(input) @@ -425,13 +425,13 @@ func ExampleS3_DeleteObject_shared00() { fmt.Println(result) } -// To delete an object (from a non-versioned bucket) -// The following example deletes an object from a non-versioned bucket. +// To delete an object +// The following example deletes an object from an S3 bucket. func ExampleS3_DeleteObject_shared01() { svc := s3.New(session.New()) input := &s3.DeleteObjectInput{ - Bucket: aws.String("ExampleBucket"), - Key: aws.String("HappyFace.jpg"), + Bucket: aws.String("examplebucket"), + Key: aws.String("objectkey.jpg"), } result, err := svc.DeleteObject(input) @@ -510,10 +510,10 @@ func ExampleS3_DeleteObjectTagging_shared01() { fmt.Println(result) } -// To delete multiple object versions from a versioned bucket -// The following example deletes objects from a bucket. The request specifies object -// versions. S3 deletes specific object versions and returns the key and versions of -// deleted objects in the response. +// To delete multiple objects from a versioned bucket +// The following example deletes objects from a bucket. The bucket is versioned, and +// the request does not specify the object version to delete. In this case, all versions +// remain in the bucket and S3 adds a delete marker. func ExampleS3_DeleteObjects_shared00() { svc := s3.New(session.New()) input := &s3.DeleteObjectsInput{ @@ -521,12 +521,10 @@ func ExampleS3_DeleteObjects_shared00() { Delete: &s3.Delete{ Objects: []*s3.ObjectIdentifier{ { - Key: aws.String("HappyFace.jpg"), - VersionId: aws.String("2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b"), + Key: aws.String("objectkey1"), }, { - Key: aws.String("HappyFace.jpg"), - VersionId: aws.String("yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd"), + Key: aws.String("objectkey2"), }, }, Quiet: aws.Bool(false), @@ -551,10 +549,10 @@ func ExampleS3_DeleteObjects_shared00() { fmt.Println(result) } -// To delete multiple objects from a versioned bucket -// The following example deletes objects from a bucket. The bucket is versioned, and -// the request does not specify the object version to delete. In this case, all versions -// remain in the bucket and S3 adds a delete marker. +// To delete multiple object versions from a versioned bucket +// The following example deletes objects from a bucket. The request specifies object +// versions. S3 deletes specific object versions and returns the key and versions of +// deleted objects in the response. func ExampleS3_DeleteObjects_shared01() { svc := s3.New(session.New()) input := &s3.DeleteObjectsInput{ @@ -562,10 +560,12 @@ func ExampleS3_DeleteObjects_shared01() { Delete: &s3.Delete{ Objects: []*s3.ObjectIdentifier{ { - Key: aws.String("objectkey1"), + Key: aws.String("HappyFace.jpg"), + VersionId: aws.String("2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b"), }, { - Key: aws.String("objectkey2"), + Key: aws.String("HappyFace.jpg"), + VersionId: aws.String("yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd"), }, }, Quiet: aws.Bool(false), @@ -996,15 +996,13 @@ func ExampleS3_GetObjectAcl_shared00() { fmt.Println(result) } -// To retrieve tag set of a specific object version -// The following example retrieves tag set of an object. The request specifies object -// version. +// To retrieve tag set of an object +// The following example retrieves tag set of an object. func ExampleS3_GetObjectTagging_shared00() { svc := s3.New(session.New()) input := &s3.GetObjectTaggingInput{ - Bucket: aws.String("examplebucket"), - Key: aws.String("exampleobject"), - VersionId: aws.String("ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"), + Bucket: aws.String("examplebucket"), + Key: aws.String("HappyFace.jpg"), } result, err := svc.GetObjectTagging(input) @@ -1025,13 +1023,15 @@ func ExampleS3_GetObjectTagging_shared00() { fmt.Println(result) } -// To retrieve tag set of an object -// The following example retrieves tag set of an object. +// To retrieve tag set of a specific object version +// The following example retrieves tag set of an object. The request specifies object +// version. func ExampleS3_GetObjectTagging_shared01() { svc := s3.New(session.New()) input := &s3.GetObjectTaggingInput{ - Bucket: aws.String("examplebucket"), - Key: aws.String("HappyFace.jpg"), + Bucket: aws.String("examplebucket"), + Key: aws.String("exampleobject"), + VersionId: aws.String("ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"), } result, err := svc.GetObjectTagging(input) @@ -1745,16 +1745,19 @@ func ExampleS3_PutBucketWebsite_shared00() { fmt.Println(result) } -// To upload an object -// The following example uploads an object to a versioning-enabled bucket. The source -// file is specified using Windows file syntax. S3 returns VersionId of the newly created -// object. +// To upload object and specify user-defined metadata +// The following example creates an object. The request also specifies optional metadata. +// If the bucket is versioning enabled, S3 returns version ID in response. func ExampleS3_PutObject_shared00() { svc := s3.New(session.New()) input := &s3.PutObjectInput{ - Body: aws.ReadSeekCloser(strings.NewReader("HappyFace.jpg")), + Body: aws.ReadSeekCloser(strings.NewReader("filetoupload")), Bucket: aws.String("examplebucket"), - Key: aws.String("HappyFace.jpg"), + Key: aws.String("exampleobject"), + Metadata: map[string]*string{ + "metadata1": aws.String("value1"), + "metadata2": aws.String("value2"), + }, } result, err := svc.PutObject(input) @@ -1806,19 +1809,16 @@ func ExampleS3_PutObject_shared01() { fmt.Println(result) } -// To upload object and specify user-defined metadata -// The following example creates an object. The request also specifies optional metadata. -// If the bucket is versioning enabled, S3 returns version ID in response. +// To upload an object and specify optional tags +// The following example uploads an object. The request specifies optional object tags. +// The bucket is versioned, therefore S3 returns version ID of the newly created object. func ExampleS3_PutObject_shared02() { svc := s3.New(session.New()) input := &s3.PutObjectInput{ - Body: aws.ReadSeekCloser(strings.NewReader("filetoupload")), - Bucket: aws.String("examplebucket"), - Key: aws.String("exampleobject"), - Metadata: map[string]*string{ - "metadata1": aws.String("value1"), - "metadata2": aws.String("value2"), - }, + Body: aws.ReadSeekCloser(strings.NewReader("c:\\HappyFace.jpg")), + Bucket: aws.String("examplebucket"), + Key: aws.String("HappyFace.jpg"), + Tagging: aws.String("key1=value1&key2=value2"), } result, err := svc.PutObject(input) @@ -1839,17 +1839,15 @@ func ExampleS3_PutObject_shared02() { fmt.Println(result) } -// To upload an object and specify canned ACL. -// The following example uploads and object. The request specifies optional canned ACL -// (access control list) to all READ access to authenticated users. If the bucket is -// versioning enabled, S3 returns version ID in response. +// To create an object. +// The following example creates an object. If the bucket is versioning enabled, S3 +// returns version ID in response. func ExampleS3_PutObject_shared03() { svc := s3.New(session.New()) input := &s3.PutObjectInput{ - ACL: aws.String("authenticated-read"), Body: aws.ReadSeekCloser(strings.NewReader("filetoupload")), Bucket: aws.String("examplebucket"), - Key: aws.String("exampleobject"), + Key: aws.String("objectkey"), } result, err := svc.PutObject(input) @@ -1870,15 +1868,16 @@ func ExampleS3_PutObject_shared03() { fmt.Println(result) } -// To create an object. -// The following example creates an object. If the bucket is versioning enabled, S3 -// returns version ID in response. +// To upload an object +// The following example uploads an object to a versioning-enabled bucket. The source +// file is specified using Windows file syntax. S3 returns VersionId of the newly created +// object. func ExampleS3_PutObject_shared04() { svc := s3.New(session.New()) input := &s3.PutObjectInput{ - Body: aws.ReadSeekCloser(strings.NewReader("filetoupload")), + Body: aws.ReadSeekCloser(strings.NewReader("HappyFace.jpg")), Bucket: aws.String("examplebucket"), - Key: aws.String("objectkey"), + Key: aws.String("HappyFace.jpg"), } result, err := svc.PutObject(input) @@ -1899,18 +1898,17 @@ func ExampleS3_PutObject_shared04() { fmt.Println(result) } -// To upload an object and specify server-side encryption and object tags -// The following example uploads an object. The request specifies the optional server-side -// encryption option. The request also specifies optional object tags. If the bucket -// is versioning enabled, S3 returns version ID in response. +// To upload an object and specify canned ACL. +// The following example uploads and object. The request specifies optional canned ACL +// (access control list) to all READ access to authenticated users. If the bucket is +// versioning enabled, S3 returns version ID in response. func ExampleS3_PutObject_shared05() { svc := s3.New(session.New()) input := &s3.PutObjectInput{ - Body: aws.ReadSeekCloser(strings.NewReader("filetoupload")), - Bucket: aws.String("examplebucket"), - Key: aws.String("exampleobject"), - ServerSideEncryption: aws.String("AES256"), - Tagging: aws.String("key1=value1&key2=value2"), + ACL: aws.String("authenticated-read"), + Body: aws.ReadSeekCloser(strings.NewReader("filetoupload")), + Bucket: aws.String("examplebucket"), + Key: aws.String("exampleobject"), } result, err := svc.PutObject(input) @@ -1931,16 +1929,18 @@ func ExampleS3_PutObject_shared05() { fmt.Println(result) } -// To upload an object and specify optional tags -// The following example uploads an object. The request specifies optional object tags. -// The bucket is versioned, therefore S3 returns version ID of the newly created object. +// To upload an object and specify server-side encryption and object tags +// The following example uploads an object. The request specifies the optional server-side +// encryption option. The request also specifies optional object tags. If the bucket +// is versioning enabled, S3 returns version ID in response. func ExampleS3_PutObject_shared06() { svc := s3.New(session.New()) input := &s3.PutObjectInput{ - Body: aws.ReadSeekCloser(strings.NewReader("c:\\HappyFace.jpg")), - Bucket: aws.String("examplebucket"), - Key: aws.String("HappyFace.jpg"), - Tagging: aws.String("key1=value1&key2=value2"), + Body: aws.ReadSeekCloser(strings.NewReader("filetoupload")), + Bucket: aws.String("examplebucket"), + Key: aws.String("exampleobject"), + ServerSideEncryption: aws.String("AES256"), + Tagging: aws.String("key1=value1&key2=value2"), } result, err := svc.PutObject(input)