The trace event details used with the custom orchestration.
" + }, + "traceId":{ + "shape":"TraceId", + "documentation":"The unique identifier of the trace.
" + } + }, + "documentation":"The trace behavior for the custom orchestration.
", + "sensitive":true + }, + "CustomOrchestrationTraceEvent":{ + "type":"structure", + "members":{ + "text":{ + "shape":"String", + "documentation":"The text that prompted the event at this step.
" + } + }, + "documentation":"The event in the custom orchestration sequence.
", + "sensitive":true + }, "DateTimestamp":{ "type":"timestamp", "documentation":"Time Stamp.
", @@ -2279,6 +2305,10 @@ "sessionState":{ "shape":"SessionState", "documentation":"Contains parameters that specify various attributes of the session. For more information, see Control session context.
If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.
Specifies the configurations for streaming.
" } } }, @@ -4064,6 +4094,25 @@ "max":4, "min":0 }, + "StreamingConfigurations":{ + "type":"structure", + "members":{ + "applyGuardrailInterval":{ + "shape":"StreamingConfigurationsApplyGuardrailIntervalInteger", + "documentation":"The guardrail interval to apply as response is generated.
" + }, + "streamFinalResponse":{ + "shape":"Boolean", + "documentation":" Specifies whether to enable streaming for the final response. This is set to false by default.
Configurations for streaming.
" + }, + "StreamingConfigurationsApplyGuardrailIntervalInteger":{ + "type":"integer", + "box":true, + "min":1 + }, "String":{"type":"string"}, "SummaryText":{ "type":"string", @@ -4163,6 +4212,10 @@ "Trace":{ "type":"structure", "members":{ + "customOrchestrationTrace":{ + "shape":"CustomOrchestrationTrace", + "documentation":"Details about the custom orchestration step in which the agent determines the order in which actions are executed.
" + }, "failureTrace":{ "shape":"FailureTrace", "documentation":"Contains information about the failure of the interaction.
" diff --git a/botocore/data/bedrock-agent/2023-06-05/service-2.json b/botocore/data/bedrock-agent/2023-06-05/service-2.json index 6a6ea6793e..5594edf497 100644 --- a/botocore/data/bedrock-agent/2023-06-05/service-2.json +++ b/botocore/data/bedrock-agent/2023-06-05/service-2.json @@ -1371,6 +1371,10 @@ "shape":"DateTimestamp", "documentation":"The time at which the agent was created.
" }, + "customOrchestration":{ + "shape":"CustomOrchestration", + "documentation":"Contains custom orchestration configurations for the agent.
" + }, "customerEncryptionKeyArn":{ "shape":"KmsKeyArn", "documentation":"The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
" @@ -1403,6 +1407,10 @@ "shape":"MemoryConfiguration", "documentation":"Contains memory configuration for the agent.
" }, + "orchestrationType":{ + "shape":"OrchestrationType", + "documentation":"Specifies the orchestration strategy for the agent.
" + }, "preparedAt":{ "shape":"DateTimestamp", "documentation":"The time at which the agent was last prepared.
" @@ -2401,6 +2409,10 @@ "documentation":"A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", "idempotencyToken":true }, + "customOrchestration":{ + "shape":"CustomOrchestration", + "documentation":"Contains details of the custom orchestration configured for the agent.
" + }, "customerEncryptionKeyArn":{ "shape":"KmsKeyArn", "documentation":"The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
" @@ -2429,6 +2441,10 @@ "shape":"MemoryConfiguration", "documentation":"Contains the details of the memory configured for the agent.
" }, + "orchestrationType":{ + "shape":"OrchestrationType", + "documentation":" Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default.
Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
" @@ -2986,6 +3002,16 @@ "type":"string", "enum":["RETURN_CONTROL"] }, + "CustomOrchestration":{ + "type":"structure", + "members":{ + "executor":{ + "shape":"OrchestrationExecutor", + "documentation":"The structure of the executor invoking the actions in custom orchestration.
" + } + }, + "documentation":"Details of custom orchestration.
" + }, "CustomTransformationConfiguration":{ "type":"structure", "required":[ @@ -6533,6 +6559,24 @@ "min":0, "pattern":"^.*$" }, + "OrchestrationExecutor":{ + "type":"structure", + "members":{ + "lambda":{ + "shape":"LambdaArn", + "documentation":"The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
" + } + }, + "documentation":"Contains details about the Lambda function containing the orchestration logic carried out upon invoking the custom orchestration.
", + "union":true + }, + "OrchestrationType":{ + "type":"string", + "enum":[ + "DEFAULT", + "CUSTOM_ORCHESTRATION" + ] + }, "OutputFlowNodeConfiguration":{ "type":"structure", "members":{ @@ -8443,6 +8487,10 @@ "shape":"AgentRoleArn", "documentation":"The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
" }, + "customOrchestration":{ + "shape":"CustomOrchestration", + "documentation":"Contains details of the custom orchestration configured for the agent.
" + }, "customerEncryptionKeyArn":{ "shape":"KmsKeyArn", "documentation":"The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
" @@ -8471,6 +8519,10 @@ "shape":"MemoryConfiguration", "documentation":"Specifies the new memory configuration for the agent.
" }, + "orchestrationType":{ + "shape":"OrchestrationType", + "documentation":" Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default.
Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
" diff --git a/botocore/data/connect/2017-08-08/service-2.json b/botocore/data/connect/2017-08-08/service-2.json index 39a2b1528a..c689ede72d 100644 --- a/botocore/data/connect/2017-08-08/service-2.json +++ b/botocore/data/connect/2017-08-08/service-2.json @@ -438,7 +438,7 @@ {"shape":"ConflictException"}, {"shape":"ServiceQuotaExceededException"} ], - "documentation":"" + "documentation":"Creates a new contact.
" }, "CreateContactFlow":{ "name":"CreateContactFlow", @@ -521,7 +521,7 @@ {"shape":"DuplicateResourceException"}, {"shape":"ResourceConflictException"} ], - "documentation":"" + "documentation":"Create new email address in the specified Amazon Connect instance. For more information about email addresses, see Create email addresses in the Amazon Connect Administrator Guide.
" }, "CreateEvaluationForm":{ "name":"CreateEvaluationForm", @@ -1020,7 +1020,7 @@ {"shape":"InternalServiceException"}, {"shape":"ResourceConflictException"} ], - "documentation":"" + "documentation":"Deletes email address from the specified Amazon Connect instance.
" }, "DeleteEvaluationForm":{ "name":"DeleteEvaluationForm", @@ -1423,7 +1423,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], - "documentation":"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.
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. After a 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 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. After a flow is published, $SAVED needs to be supplied to view saved content that has not been published.
Describe email address form the specified Amazon Connect instance.
" }, "DescribeEvaluationForm":{ "name":"DescribeEvaluationForm", @@ -2283,7 +2283,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], - "documentation":"" + "documentation":"Provides information about contact tree, a list of associated contacts with a unique identifier.
" }, "ListAuthenticationProfiles":{ "name":"ListAuthenticationProfiles", @@ -3205,7 +3205,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], - "documentation":"Searches the contact flows in an Amazon Connect instance, with optional filtering.
" + "documentation":"Searches the flows in an Amazon Connect instance, with optional filtering.
" }, "SearchContacts":{ "name":"SearchContacts", @@ -3240,7 +3240,7 @@ {"shape":"InvalidRequestException"}, {"shape":"InternalServiceException"} ], - "documentation":"" + "documentation":"Searches email address in an instance, with optional filtering.
" }, "SearchHoursOfOperations":{ "name":"SearchHoursOfOperations", @@ -3463,7 +3463,7 @@ {"shape":"InternalServiceException"}, {"shape":"IdempotencyException"} ], - "documentation":"" + "documentation":"Send outbound email for outbound campaigns. For more information about outbound campaigns, see Set up Amazon Connect outbound campaigns.
Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API.
Provides a pre-signed Amazon S3 URL in response for uploading your content.
You may only use this API to upload attachments to an Amazon Connect Case.
Provides a pre-signed Amazon S3 URL in response for uploading your content.
You may only use this API to upload attachments to an Amazon Connect Case or Amazon Connect Email.
Creates an inbound email contact and initiates a flow to start the email contact for the customer. Response of this API provides the ContactId of the email contact created.
" }, "StartOutboundChatContact":{ "name":"StartOutboundChatContact", @@ -3607,7 +3607,7 @@ {"shape":"InternalServiceException"}, {"shape":"IdempotencyException"} ], - "documentation":"" + "documentation":"Initiates a flow to send an agent reply or outbound email contact (created from the CreateContact API) to a customer.
" }, "StartOutboundVoiceContact":{ "name":"StartOutboundVoiceContact", @@ -3793,7 +3793,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], - "documentation":"Adds the specified tags to the specified resource.
Some of the supported resource types are agents, routing profiles, queues, quick connects, contact flows, agent statuses, hours of operation, phone numbers, security profiles, and task templates. For a complete list, see Tagging resources in Amazon Connect.
For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.
" + "documentation":"Adds the specified tags to the specified resource.
Some of the supported resource types are agents, routing profiles, queues, quick connects, flows, agent statuses, hours of operation, phone numbers, security profiles, and task templates. For a complete list, see Tagging resources in Amazon Connect.
For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.
" }, "TransferContact":{ "name":"TransferContact", @@ -3948,7 +3948,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], - "documentation":"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 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. After a flow is published, $SAVED needs to be supplied to view saved content that has not been published.
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 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. After a flow is published, $SAVED needs to be supplied to view saved content that has not been published.
Updates an email address metadata. For more information about email addresses, see Create email addresses in the Amazon Connect Administrator Guide.
" }, "UpdateEvaluationForm":{ "name":"UpdateEvaluationForm", @@ -4316,7 +4316,7 @@ {"shape":"AccessDeniedException"}, {"shape":"ConditionalOperationFailedException"} ], - "documentation":"" + "documentation":"Updates the outbound email address Id for a specified queue.
" }, "UpdateQueueStatus":{ "name":"UpdateQueueStatus", @@ -4785,14 +4785,14 @@ "members":{ "ToList":{ "shape":"EmailRecipientsList", - "documentation":"" + "documentation":"List of additional TO email recipients for an email contact.
" }, "CcList":{ "shape":"EmailRecipientsList", - "documentation":"" + "documentation":"List of additional CC email recipients for an email contact.
" } }, - "documentation":"" + "documentation":"List of additional email addresses for an email contact.
" }, "AfterContactWorkTimeLimit":{ "type":"integer", @@ -5663,42 +5663,42 @@ "members":{ "ContactId":{ "shape":"ContactId", - "documentation":"" + "documentation":"The identifier of the contact in this instance of Amazon Connect.
" }, "ContactArn":{ "shape":"ARN", - "documentation":"" + "documentation":"The Amazon Resource Name (ARN) of the contact
" }, "InitiationTimestamp":{ "shape":"Timestamp", - "documentation":"" + "documentation":"The date and time this contact was initiated, in UTC time.
" }, "DisconnectTimestamp":{ "shape":"Timestamp", - "documentation":"" + "documentation":"The timestamp when the customer endpoint disconnected from Amazon Connect.
" }, "InitialContactId":{ "shape":"ContactId", - "documentation":"" + "documentation":"If this contact is related to other contacts, this is the ID of the initial contact.
" }, "PreviousContactId":{ "shape":"ContactId", - "documentation":"" + "documentation":"If this contact is not the first contact, this is the ID of the previous contact.
" }, "RelatedContactId":{ "shape":"ContactId", - "documentation":"" + "documentation":"The contactId that is related to this contact.
" }, "InitiationMethod":{ "shape":"ContactInitiationMethod", - "documentation":"" + "documentation":"Indicates how the contact was initiated.
" }, "Channel":{ "shape":"Channel", - "documentation":"" + "documentation":"How the contact reached your contact center.
" } }, - "documentation":"" + "documentation":"Contact summary of a contact in contact tree associated with unique identifier.
" }, "AssociatedContactSummaryList":{ "type":"list", @@ -5831,7 +5831,7 @@ }, "Arn":{ "shape":"ReferenceArn", - "documentation":"" + "documentation":"The Amazon Resource Name (ARN) of the attachment reference.
" } }, "documentation":"Information about a reference when the referenceType is ATTACHMENT. Otherwise, null.
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. The supported resources are Cases and Email.
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.
This value must be a valid ARN.
The resource to which the attached file is (being) uploaded to. The supported resources are Cases and Email.
This value must be a valid ARN.
A conditional check failed.
", "error":{"httpStatusCode":409}, "exception":true }, @@ -6648,7 +6648,7 @@ }, "ContactAssociationId":{ "shape":"ContactId", - "documentation":"" + "documentation":"This is the root contactId which is used as a unique identifier for all subsequent contacts in a contact tree.
" }, "InitiationMethod":{ "shape":"ContactInitiationMethod", @@ -6716,11 +6716,11 @@ }, "CustomerEndpoint":{ "shape":"EndpointInfo", - "documentation":"" + "documentation":"The customer or external third party participant endpoint.
" }, "SystemEndpoint":{ "shape":"EndpointInfo", - "documentation":"" + "documentation":"The system endpoint. For INBOUND, this is the phone number or email address that the customer dialed. For OUTBOUND and EXTERNAL_OUTBOUND, this is the outbound caller ID number assigned to the outbound queue that is used to dial the customer. For callback, this shows up as Softphone for calls handled by agents with softphone.
List of additional email addresses for an email contact.
" }, "SegmentAttributes":{ "shape":"SegmentAttributes", @@ -6855,7 +6855,7 @@ }, "Status":{ "shape":"ContactFlowStatus", - "documentation":"The status of the contact flow.
" + "documentation":"The status of the flow.
" }, "Description":{ "shape":"ContactFlowDescription", @@ -6869,10 +6869,6 @@ "shape":"TagMap", "documentation":"The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" }, - "IsDefault":{ - "shape":"Boolean", - "documentation":"Amazon Connect includes a set of default flows that have already been published. It uses them to power your contact center.
" - }, "FlowContentSha256":{ "shape":"FlowContentSha256", "documentation":"Indicates the checksum value of the flow content.
" @@ -6887,11 +6883,11 @@ }, "LastModifiedTime":{ "shape":"Timestamp", - "documentation":"The time at which the contact flow was last modified.
" + "documentation":"The time at which the flow was last modified.
" }, "LastModifiedRegion":{ "shape":"RegionName", - "documentation":"The region in which the contact flow was last modified
" + "documentation":"The region in which the flow was last modified
" } }, "documentation":"Contains information about a flow.
" @@ -7074,7 +7070,7 @@ "documentation":"The status of the flow.
" } }, - "documentation":"The search criteria to be used to return contact flows.
" + "documentation":"The search criteria to be used to return flows.
" }, "ContactFlowSearchFilter":{ "type":"structure", @@ -7126,7 +7122,7 @@ }, "ContactFlowStatus":{ "shape":"ContactFlowStatus", - "documentation":"The status of the contact flow.
" + "documentation":"The status of the flow.
" } }, "documentation":"Contains summary information about a flow.
You can also create and update flows using the Amazon Connect Flow language.
" @@ -7170,7 +7166,7 @@ "documentation":"The identifier of the flow version.
" } }, - "documentation":"A summary of a contact flow version's metadata.
" + "documentation":"A summary of a flow version's metadata.
" }, "ContactFlowVersionSummaryList":{ "type":"list", @@ -7264,7 +7260,7 @@ }, "SegmentAttributes":{ "shape":"ContactSearchSummarySegmentAttributes", - "documentation":"" + "documentation":"Set of segment attributes for a contact.
" } }, "documentation":"Information of returned contact.
" @@ -7302,10 +7298,10 @@ "members":{ "ValueString":{ "shape":"SegmentAttributeValueString", - "documentation":"" + "documentation":"The value of a segment attribute represented as a string.
" } }, - "documentation":"" + "documentation":"The value of a segment attribute. This is structured as a map with a single key-value pair. The key 'valueString' indicates that the attribute type is a string, and its corresponding value is the actual string value of the segment attribute.
" }, "ContactSearchSummarySegmentAttributes":{ "type":"map", @@ -7653,56 +7649,56 @@ "members":{ "InstanceId":{ "shape":"InstanceId", - "documentation":"" + "documentation":"The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
" }, "ClientToken":{ "shape":"ClientToken", - "documentation":"", + "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "idempotencyToken":true }, "RelatedContactId":{ "shape":"ContactId", - "documentation":"" + "documentation":"The identifier of the contact in this instance of Amazon Connect.
" }, "Attributes":{ "shape":"Attributes", - "documentation":"" + "documentation":"A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.
There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
" }, "References":{ "shape":"ContactReferences", - "documentation":"" + "documentation":"A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL | ATTACHMENT.
" }, "Channel":{ "shape":"Channel", - "documentation":"" + "documentation":"The channel for the contact
" }, "InitiationMethod":{ "shape":"ContactInitiationMethod", - "documentation":"" + "documentation":"Indicates how the contact was initiated.
" }, "ExpiryDurationInMinutes":{ "shape":"ExpiryDurationInMinutes", - "documentation":"" + "documentation":"Number of minutes the contact will be active for before expiring
" }, "UserInfo":{ "shape":"UserInfo", - "documentation":"" + "documentation":"User details for the contact
" }, "InitiateAs":{ "shape":"InitiateAs", - "documentation":"" + "documentation":"Initial state of the contact when it's created
" }, "Name":{ "shape":"Name", - "documentation":"" + "documentation":"The name of a the contact.
" }, "Description":{ "shape":"Description", - "documentation":"" + "documentation":"A description of the contact.
" }, "SegmentAttributes":{ "shape":"SegmentAttributes", - "documentation":"" + "documentation":"A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.
Attribute keys can include only alphanumeric, -, and _.
This field can be used to set Segment Contact Expiry as a duration in minutes.
To set contact expiry, a ValueMap must be specified containing the integer number of minutes the contact will be active for before expiring, with SegmentAttributes like { \"connect:ContactExpiry\": {\"ValueMap\" : { \"ExpiryDuration\": { \"ValueInteger\": 135}}}}.
The identifier of the contact in this instance of Amazon Connect.
" }, "ContactArn":{ "shape":"ARN", - "documentation":"" + "documentation":"The Amazon Resource Name (ARN) of the created contact.
" } } }, @@ -7728,29 +7724,29 @@ "members":{ "Description":{ "shape":"Description", - "documentation":"" + "documentation":"The description of the email address.
" }, "InstanceId":{ "shape":"InstanceId", - "documentation":"", + "documentation":"The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "location":"uri", "locationName":"InstanceId" }, "EmailAddress":{ "shape":"EmailAddress", - "documentation":"" + "documentation":"The email address with the instance, in [^\\s@]+@[^\\s@]+\\.[^\\s@]+ format.
" }, "DisplayName":{ "shape":"EmailAddressDisplayName", - "documentation":"" + "documentation":"The display name of email address
" }, "Tags":{ "shape":"TagMap", - "documentation":"" + "documentation":"The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" }, "ClientToken":{ "shape":"ClientToken", - "documentation":"" + "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
" } } }, @@ -7759,11 +7755,11 @@ "members":{ "EmailAddressId":{ "shape":"EmailAddressId", - "documentation":"" + "documentation":"The identifier of the email address.
" }, "EmailAddressArn":{ "shape":"EmailAddressArn", - "documentation":"" + "documentation":"The Amazon Resource Name (ARN) of the email address.
" } } }, @@ -8156,7 +8152,7 @@ }, "OutboundEmailConfig":{ "shape":"OutboundEmailConfig", - "documentation":"" + "documentation":"The outbound email address ID for a specified queue.
" }, "HoursOfOperationId":{ "shape":"HoursOfOperationId", @@ -8453,7 +8449,7 @@ }, "SelfAssignFlowId":{ "shape":"ContactFlowId", - "documentation":"" + "documentation":"The ContactFlowId for the flow that will be run if this template is used to create a self-assigned task.
" }, "Constraints":{ "shape":"TaskTemplateConstraints", @@ -9237,13 +9233,13 @@ "members":{ "InstanceId":{ "shape":"InstanceId", - "documentation":"", + "documentation":"The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "location":"uri", "locationName":"InstanceId" }, "EmailAddressId":{ "shape":"EmailAddressId", - "documentation":"", + "documentation":"The identifier of the email address.
", "location":"uri", "locationName":"EmailAddressId" } @@ -9895,13 +9891,13 @@ "members":{ "InstanceId":{ "shape":"InstanceId", - "documentation":"", + "documentation":"The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "location":"uri", "locationName":"InstanceId" }, "EmailAddressId":{ "shape":"EmailAddressId", - "documentation":"", + "documentation":"The identifier of the email address.
", "location":"uri", "locationName":"EmailAddressId" } @@ -9912,35 +9908,35 @@ "members":{ "EmailAddressId":{ "shape":"EmailAddressId", - "documentation":"" + "documentation":"The identifier of the email address.
" }, "EmailAddressArn":{ "shape":"EmailAddressArn", - "documentation":"" + "documentation":"The Amazon Resource Name (ARN) of the email address.
" }, "EmailAddress":{ "shape":"EmailAddress", - "documentation":"" + "documentation":"The email address with the instance, in [^\\s@]+@[^\\s@]+\\.[^\\s@]+ format.
" }, "DisplayName":{ "shape":"EmailAddressDisplayName", - "documentation":"" + "documentation":"The display name of email address
" }, "Description":{ "shape":"Description", - "documentation":"" + "documentation":"The description of the email address.
" }, "CreateTimestamp":{ "shape":"ISO8601Datetime", - "documentation":"" + "documentation":"The email address creation timestamp in ISO 8601 Datetime.
" }, "ModifiedTimestamp":{ "shape":"ISO8601Datetime", - "documentation":"" + "documentation":"The email address last modification timestamp in ISO 8601 Datetime.
" }, "Tags":{ "shape":"TagMap", - "documentation":"" + "documentation":"The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } } }, @@ -11055,14 +11051,14 @@ "members":{ "EmailAddress":{ "shape":"EmailAddress", - "documentation":"" + "documentation":"The email address with the instance, in [^\\s@]+@[^\\s@]+\\.[^\\s@]+ format.
" }, "DisplayName":{ "shape":"EmailAddressDisplayName", - "documentation":"" + "documentation":"The display name of email address.
" } }, - "documentation":"" + "documentation":"Contains information about a source or destination email address
" }, "EmailAddressList":{ "type":"list", @@ -11073,26 +11069,26 @@ "members":{ "EmailAddressId":{ "shape":"EmailAddressId", - "documentation":"" + "documentation":"The identifier of the email address.
" }, "EmailAddressArn":{ "shape":"EmailAddressArn", - "documentation":"" + "documentation":"The Amazon Resource Name (ARN) of the email address.
" }, "EmailAddress":{ "shape":"EmailAddress", - "documentation":"" + "documentation":"The email address with the instance, in [^\\s@]+@[^\\s@]+\\.[^\\s@]+ format.
" }, "Description":{ "shape":"Description", - "documentation":"" + "documentation":"The description of the email address.
" }, "DisplayName":{ "shape":"EmailAddressDisplayName", - "documentation":"" + "documentation":"The display name of email address.
" } }, - "documentation":"" + "documentation":"Contains information about an email address for a contact center.
" }, "EmailAddressRecipientList":{ "type":"list", @@ -11109,22 +11105,22 @@ "members":{ "OrConditions":{ "shape":"EmailAddressSearchConditionList", - "documentation":"" + "documentation":"A list of conditions which would be applied together with an OR condition.
" }, "AndConditions":{ "shape":"EmailAddressSearchConditionList", - "documentation":"" + "documentation":"A list of conditions which would be applied together with an AND condition.
" }, "StringCondition":{"shape":"StringCondition"} }, - "documentation":"" + "documentation":"The search criteria to be used to return email addresses.
" }, "EmailAddressSearchFilter":{ "type":"structure", "members":{ "TagFilter":{"shape":"ControlPlaneTagFilter"} }, - "documentation":"" + "documentation":"Filters to be applied to search results.
" }, "EmailAttachment":{ "type":"structure", @@ -11135,14 +11131,14 @@ "members":{ "FileName":{ "shape":"FileName", - "documentation":"" + "documentation":"A case-sensitive name of the attached file being uploaded.
" }, "S3Url":{ "shape":"PreSignedAttachmentUrl", - "documentation":"" + "documentation":"The pre-signed URLs for the S3 bucket where the email attachment is stored.
" } }, - "documentation":"" + "documentation":"Information about the email attachment files.
" }, "EmailAttachments":{ "type":"list", @@ -11181,28 +11177,28 @@ "members":{ "Name":{ "shape":"ReferenceKey", - "documentation":"" + "documentation":"The name of the email message reference
" }, "Arn":{ "shape":"ReferenceArn", - "documentation":"" + "documentation":"The Amazon Resource Name (ARN) of the email message reference
" } }, - "documentation":"" + "documentation":"Information about the reference when the referenceType is EMAIL_MESSAGE. Otherwise, null.
Address of the email recipient.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
" }, "DisplayName":{ "shape":"EndpointDisplayName", - "documentation":"" + "documentation":"Display name of the email recipient.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
" } }, - "documentation":"" + "documentation":"Information about the email recipient
" }, "EmailRecipientsList":{ "type":"list", @@ -11285,18 +11281,18 @@ "members":{ "Type":{ "shape":"EndpointType", - "documentation":"" + "documentation":"Type of endpoint.
" }, "Address":{ "shape":"EndpointAddress", - "documentation":"" + "documentation":"Address of the endpoint.
" }, "DisplayName":{ "shape":"EndpointDisplayName", - "documentation":"" + "documentation":"Display name of the endpoint.
" } }, - "documentation":"" + "documentation":"Information about the endpoint.
" }, "EndpointType":{ "type":"string", @@ -12481,7 +12477,7 @@ "members":{ "InstanceId":{ "shape":"InstanceId", - "documentation":"The unique identifier of the Connect instance.
", + "documentation":"The unique identifier of the Amazon Connect instance.
", "location":"uri", "locationName":"InstanceId" }, @@ -12499,7 +12495,7 @@ }, "AssociatedResourceArn":{ "shape":"ARN", - "documentation":"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. The supported resources are Cases and Email.
This value must be a valid ARN.
ContactFlowId for the flow that will be run if this template is used to create a self-assigned task
" }, "Constraints":{ "shape":"TaskTemplateConstraints", @@ -13713,14 +13709,14 @@ "members":{ "ToAddresses":{ "shape":"EmailAddressRecipientList", - "documentation":"" + "documentation":"The additional recipients information present in to list.
" }, "CcAddresses":{ "shape":"EmailAddressRecipientList", - "documentation":"" + "documentation":"The additional recipients information present in cc list.
" } }, - "documentation":"" + "documentation":"The additional TO CC recipients information of inbound email.
" }, "InboundCallsEnabled":{"type":"boolean"}, "InboundEmailContent":{ @@ -13729,14 +13725,14 @@ "members":{ "MessageSourceType":{ "shape":"InboundMessageSourceType", - "documentation":"" + "documentation":"The message source type, that is, RAW.
The raw email body content.
" } }, - "documentation":"" + "documentation":"Information about email body content.
" }, "InboundMessageSourceType":{ "type":"string", @@ -13752,22 +13748,22 @@ "members":{ "Subject":{ "shape":"InboundSubject", - "documentation":"" + "documentation":"The email subject.
" }, "Body":{ "shape":"Body", - "documentation":"" + "documentation":"The email message body.
" }, "ContentType":{ "shape":"EmailMessageContentType", - "documentation":"" + "documentation":"Type of content, that is, text/plain or text/html.
Headers present in inbound email.
" } }, - "documentation":"" + "documentation":"Information about the raw email body content.
" }, "InboundSubject":{ "type":"string", @@ -14455,25 +14451,25 @@ "members":{ "InstanceId":{ "shape":"InstanceId", - "documentation":"", + "documentation":"The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "location":"uri", "locationName":"InstanceId" }, "ContactId":{ "shape":"ContactId", - "documentation":"", + "documentation":"The identifier of the contact in this instance of Amazon Connect.
", "location":"querystring", "locationName":"contactId" }, "MaxResults":{ "shape":"ListAssociatedContactsRequestMaxResults", - "documentation":"", + "documentation":"The maximum number of results to return per page.
The maximum number of results to return per page. The default MaxResult size is 25.
Valid Range: Minimum value of 1. Maximum value of 100.
", "location":"querystring", "locationName":"maxResults" }, "NextToken":{ "shape":"NextToken", - "documentation":"", + "documentation":"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.
", "location":"querystring", "locationName":"nextToken" } @@ -14489,11 +14485,11 @@ "members":{ "ContactSummaryList":{ "shape":"AssociatedContactSummaryList", - "documentation":"" + "documentation":"List of the contact summary for all the contacts in contact tree associated with unique identifier.
" }, "NextToken":{ "shape":"NextToken", - "documentation":"" + "documentation":"If there are additional results, this is the token for the next set of results.
" } } }, @@ -16943,10 +16939,10 @@ "members":{ "CcEmailAddresses":{ "shape":"EmailAddressRecipientList", - "documentation":"" + "documentation":"The additional CC email address recipients information.
" } }, - "documentation":"" + "documentation":"The additional recipients information of outbound email.
" }, "OutboundCallerConfig":{ "type":"structure", @@ -16989,10 +16985,10 @@ "members":{ "OutboundEmailAddressId":{ "shape":"EmailAddressId", - "documentation":"" + "documentation":"The identifier of the email address.
" } }, - "documentation":"" + "documentation":"The outbound email address Id.
" }, "OutboundEmailContent":{ "type":"structure", @@ -17000,18 +16996,18 @@ "members":{ "MessageSourceType":{ "shape":"OutboundMessageSourceType", - "documentation":"" + "documentation":"The message source type, that is, RAW or TEMPLATE.
Information about template message configuration.
" }, "RawMessage":{ "shape":"OutboundRawMessage", - "documentation":"" + "documentation":"The raw email body content.
" } }, - "documentation":"" + "documentation":"Information about email body content.
" }, "OutboundMessageSourceType":{ "type":"string", @@ -17030,18 +17026,18 @@ "members":{ "Subject":{ "shape":"OutboundSubject", - "documentation":"" + "documentation":"The email subject.
" }, "Body":{ "shape":"Body", - "documentation":"" + "documentation":"The email message body.
" }, "ContentType":{ "shape":"EmailMessageContentType", - "documentation":"" + "documentation":"Type of content, that is, text/plain or text/html.
Information about the raw email body content.
" }, "OutboundRequestId":{ "type":"string", @@ -17059,7 +17055,7 @@ "members":{ "Message":{"shape":"Message"} }, - "documentation":"Thrown for analyzed content when requested OutputType was not enabled for a given contact. For example, if an OutputType.Raw was requested for a contact that had `RedactedOnly` Redaction policy set in Contact flow.
", + "documentation":"Thrown for analyzed content when requested OutputType was not enabled for a given contact. For example, if an OutputType.Raw was requested for a contact that had `RedactedOnly` Redaction policy set in the flow.
", "error":{"httpStatusCode":404}, "exception":true }, @@ -18019,7 +18015,7 @@ }, "OutboundEmailConfig":{ "shape":"OutboundEmailConfig", - "documentation":"" + "documentation":"The outbound email address ID for a specified queue.
" }, "HoursOfOperationId":{ "shape":"HoursOfOperationId", @@ -18854,15 +18850,15 @@ }, "Status":{ "shape":"ReferenceStatus", - "documentation":"" + "documentation":"Status of the attachment reference type.
" }, "Arn":{ "shape":"ReferenceArn", - "documentation":"" + "documentation":"The Amazon Resource Name (ARN) of the reference
" }, "StatusReason":{ "shape":"ReferenceStatusReason", - "documentation":"" + "documentation":"Relevant details why the reference was not successfully created.
" } }, "documentation":"Well-formed data on a contact, used by agents to complete a contact request. You can have up to 4,096 UTF-8 bytes across all references for a contact.
" @@ -18912,7 +18908,7 @@ }, "EmailMessage":{ "shape":"EmailMessageReference", - "documentation":"" + "documentation":"Information about the reference when the referenceType is EMAIL_MESSAGE. Otherwise, null.
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.
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 contact flow modules.
" + "documentation":"The search criteria to be used to return flow modules.
" }, "NextToken":{ "shape":"NextToken2500", @@ -19937,7 +19933,7 @@ }, "ApproximateTotalCount":{ "shape":"ApproximateTotalCount", - "documentation":"The total number of contact flows which matched your search query.
" + "documentation":"The total number of flows which matched your search query.
" } } }, @@ -19981,7 +19977,7 @@ }, "ApproximateTotalCount":{ "shape":"ApproximateTotalCount", - "documentation":"The total number of contact flows which matched your search query.
" + "documentation":"The total number of flows which matched your search query.
" } } }, @@ -20109,7 +20105,7 @@ }, "SearchableSegmentAttributes":{ "shape":"SearchableSegmentAttributes", - "documentation":"" + "documentation":"The search criteria based on searchable segment attributes of a contact.
" } }, "documentation":"A structure of search criteria to be used to return contacts.
" @@ -20120,23 +20116,23 @@ "members":{ "InstanceId":{ "shape":"InstanceId", - "documentation":"" + "documentation":"The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
" }, "MaxResults":{ "shape":"MaxResult100", - "documentation":"" + "documentation":"The maximum number of results to return per page.
" }, "NextToken":{ "shape":"NextToken2500", - "documentation":"" + "documentation":"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.
" }, "SearchCriteria":{ "shape":"EmailAddressSearchCriteria", - "documentation":"" + "documentation":"The search criteria to be used to return email addresses.
" }, "SearchFilter":{ "shape":"EmailAddressSearchFilter", - "documentation":"" + "documentation":"Filters to be applied to search results.
" } } }, @@ -20145,15 +20141,15 @@ "members":{ "NextToken":{ "shape":"NextToken", - "documentation":"" + "documentation":"If there are additional results, this is the token for the next set of results.
" }, "EmailAddresses":{ "shape":"EmailAddressList", - "documentation":"" + "documentation":"List of email addresses matching SearchFilter and SearchCriteria
" }, "ApproximateTotalCount":{ "shape":"ApproximateTotalCount", - "documentation":"" + "documentation":"The total number of email addresses which matched your search query.
" } } }, @@ -20691,7 +20687,7 @@ "documentation":"The list of values to search for within a user-defined contact attribute.
" } }, - "documentation":"The search criteria based on user-defned contact attribute key and values to search on.
" + "documentation":"The search criteria based on user-defined contact attribute key and values to search on.
" }, "SearchableContactAttributesCriteriaList":{ "type":"list", @@ -20728,14 +20724,14 @@ "members":{ "Criteria":{ "shape":"SearchableSegmentAttributesCriteriaList", - "documentation":"" + "documentation":"The list of criteria based on searchable segment attributes.
" }, "MatchType":{ "shape":"SearchContactsMatchType", - "documentation":"" + "documentation":"The match type combining search criteria using multiple searchable segment attributes.
" } }, - "documentation":"" + "documentation":"The search criteria based on searchable segment attributes of a contact
" }, "SearchableSegmentAttributesCriteria":{ "type":"structure", @@ -20746,14 +20742,14 @@ "members":{ "Key":{ "shape":"SearchableSegmentAttributeKey", - "documentation":"" + "documentation":"The key containing a searchable segment attribute.
" }, "Values":{ "shape":"SearchableSegmentAttributeValueList", - "documentation":"" + "documentation":"The list of values to search for within a searchable segment attribute.
" } }, - "documentation":"" + "documentation":"The search criteria based on searchable segment attribute key and values to search on.
" }, "SearchableSegmentAttributesCriteriaList":{ "type":"list", @@ -20968,10 +20964,24 @@ "ValueString":{ "shape":"SegmentAttributeValueString", "documentation":"The value of a segment attribute.
" + }, + "ValueMap":{ + "shape":"SegmentAttributeValueMap", + "documentation":"The value of a segment attribute.
" + }, + "ValueInteger":{ + "shape":"SegmentAttributeValueInteger", + "documentation":"The value of a segment attribute.
" } }, "documentation":"A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "location":"uri", "locationName":"InstanceId" }, "FromEmailAddress":{ "shape":"EmailAddressInfo", - "documentation":"" + "documentation":"The email address to be used for sending email.
" }, "DestinationEmailAddress":{ "shape":"EmailAddressInfo", - "documentation":"" + "documentation":"The email address to send the email to.
" }, "AdditionalRecipients":{ "shape":"OutboundAdditionalRecipients", - "documentation":"" + "documentation":"The additional recipients address of the email in CC.
" }, "EmailMessage":{ "shape":"OutboundEmailContent", - "documentation":"" + "documentation":"The email message body to be sent to the newly created email.
" }, "TrafficType":{ "shape":"TrafficType", - "documentation":"" + "documentation":"Denotes the class of traffic.
" }, "SourceCampaign":{ "shape":"SourceCampaign", - "documentation":"" + "documentation":"A Campaign object need for Campaign traffic type.
" }, "ClientToken":{ "shape":"ClientToken", - "documentation":"", + "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "idempotencyToken":true } } @@ -21124,10 +21134,10 @@ "members":{ "AttachedFileServiceQuotaExceededExceptionReason":{ "shape":"AttachedFileServiceQuotaExceededExceptionReason", - "documentation":"" + "documentation":"Total file size of all files or total number of files exceeds the service quota
" } }, - "documentation":"", + "documentation":"The reason for the exception.
", "union":true }, "SignInConfig":{ @@ -21250,14 +21260,14 @@ "members":{ "CampaignId":{ "shape":"CampaignId", - "documentation":"" + "documentation":"A unique identifier for a campaign.
" }, "OutboundRequestId":{ "shape":"OutboundRequestId", - "documentation":"" + "documentation":"A unique identifier for a each request part of same campaign.
" } }, - "documentation":"" + "documentation":"Information about the campaign.
" }, "SourceId":{ "type":"string", @@ -21308,11 +21318,11 @@ }, "FileUseCaseType":{ "shape":"FileUseCaseType", - "documentation":"The use case for the file.
" + "documentation":"The use case for the file.
Only ATTACHMENTS are supported.
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. The supported resources are Cases and Email.
This value must be a valid ARN.
The identifier of the flow for initiating the chat. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
" + "documentation":"The identifier of the flow for initiating the chat. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
" }, "Attributes":{ "shape":"Attributes", @@ -21559,59 +21569,59 @@ "members":{ "InstanceId":{ "shape":"InstanceId", - "documentation":"" + "documentation":"The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
" }, "FromEmailAddress":{ "shape":"EmailAddressInfo", - "documentation":"" + "documentation":"The email address of the customer.
" }, "DestinationEmailAddress":{ "shape":"EmailAddress", - "documentation":"" + "documentation":"The email address associated with the instance.
" }, "Description":{ "shape":"Description", - "documentation":"" + "documentation":"A description of the email contact.
" }, "References":{ "shape":"ContactReferences", - "documentation":"" + "documentation":"A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Emails can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE. EMAIL | EMAIL_MESSAGE |ATTACHMENT are not a supported reference type during email creation.
The name of a email that is shown to an agent in the Contact Control Panel (CCP).
" }, "EmailMessage":{ "shape":"InboundEmailContent", - "documentation":"" + "documentation":"The email message body to be sent to the newly created email.
" }, "AdditionalRecipients":{ "shape":"InboundAdditionalRecipients", - "documentation":"" + "documentation":"The addtional recipients address of the email.
" }, "Attachments":{ "shape":"EmailAttachments", - "documentation":"" + "documentation":"List of S3 presigned URLs of email attachments and their file name.
" }, "ContactFlowId":{ "shape":"ContactFlowId", - "documentation":"" + "documentation":"The identifier of the flow for initiating the emails. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
" }, "RelatedContactId":{ "shape":"ContactId", - "documentation":"" + "documentation":"The contactId that is related to this contact. Linking emails together by using RelatedContactID copies over contact attributes from the related email contact to the new email contact. All updates to user-defined attributes in the new email contact are limited to the individual contact ID. There are no limits to the number of contacts that can be linked by using RelatedContactId.
A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.
There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
" }, "SegmentAttributes":{ "shape":"SegmentAttributes", - "documentation":"" + "documentation":"A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.
Attribute keys can include only alphanumeric, -, and _.
This field can be used to show channel subtype, such as connect:Guide.
To set contact expiry, a ValueMap must be specified containing the integer number of minutes the contact will be active for before expiring, with SegmentAttributes like { \"connect:ContactExpiry\": {\"ValueMap\" : { \"ExpiryDuration\": { \"ValueInteger\":135}}}}.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "idempotencyToken":true } } @@ -21621,7 +21631,7 @@ "members":{ "ContactId":{ "shape":"ContactId", - "documentation":"" + "documentation":"The identifier of this contact within the Amazon Connect instance.
" } } }, @@ -21694,31 +21704,31 @@ "members":{ "InstanceId":{ "shape":"InstanceId", - "documentation":"" + "documentation":"The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
" }, "ContactId":{ "shape":"ContactId", - "documentation":"" + "documentation":"The identifier of the contact in this instance of Amazon Connect.
" }, "FromEmailAddress":{ "shape":"EmailAddressInfo", - "documentation":"" + "documentation":"The email address associated with the instance.
" }, "DestinationEmailAddress":{ "shape":"EmailAddressInfo", - "documentation":"" + "documentation":"The email address of the customer.
" }, "AdditionalRecipients":{ "shape":"OutboundAdditionalRecipients", - "documentation":"" + "documentation":"The addtional recipients address of email in CC.
" }, "EmailMessage":{ "shape":"OutboundEmailContent", - "documentation":"" + "documentation":"The email message body to be sent to the newly created email.
" }, "ClientToken":{ "shape":"ClientToken", - "documentation":"", + "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "idempotencyToken":true } } @@ -21728,7 +21738,7 @@ "members":{ "ContactId":{ "shape":"ContactId", - "documentation":"" + "documentation":"The identifier of the contact in this instance of Amazon Connect.
" } } }, @@ -21852,7 +21862,7 @@ }, "ContactFlowId":{ "shape":"ContactFlowId", - "documentation":"The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
" + "documentation":"The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
" }, "Attributes":{ "shape":"Attributes", @@ -21893,7 +21903,7 @@ }, "SegmentAttributes":{ "shape":"SegmentAttributes", - "documentation":"" + "documentation":"A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.
Attribute keys can include only alphanumeric, -, and _.
This field can be used to set Contact Expiry as a duration in minutes and set a UserId for the User who created a task.
To set contact expiry, a ValueMap must be specified containing the integer number of minutes the contact will be active for before expiring, with SegmentAttributes like { \"connect:ContactExpiry\": {\"ValueMap\" : { \"ExpiryDuration\": { \"ValueInteger\": 135}}}}.
To set the created by user, a valid AgentResourceId must be supplied, with SegmentAttributes like { \"connect:CreatedByUser\" { \"ValueString\": \"arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/agent/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"}}}.
An object that specifies the custom attributes values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template.
" }, "CustomerProfileAttributes":{ "shape":"CustomerProfileAttributesSerialized", - "documentation":"" + "documentation":"An object that specifies the customer profile attributes values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template.
" } }, - "documentation":"" + "documentation":"Information about the template attributes.
" }, "TemplateId":{ "type":"string", @@ -22673,18 +22683,18 @@ "members":{ "KnowledgeBaseId":{ "shape":"MessageTemplateKnowledgeBaseId", - "documentation":"" + "documentation":"The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
" }, "MessageTemplateId":{ "shape":"MessageTemplateId", - "documentation":"" + "documentation":"The identifier of the message template Id.
" }, "TemplateAttributes":{ "shape":"TemplateAttributes", - "documentation":"" + "documentation":"Information about template attributes, that is, CustomAttributes or CustomerProfileAttributes.
" } }, - "documentation":"" + "documentation":"Information about template message configuration.
" }, "Threshold":{ "type":"structure", @@ -23421,7 +23431,7 @@ }, "SegmentAttributes":{ "shape":"SegmentAttributes", - "documentation":"" + "documentation":"A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.
Attribute keys can include only alphanumeric, -, and _.
This field can be used to show channel subtype, such as connect:Guide.
Currently Contact Expiry is the only segment attribute which can be updated by using the UpdateContact API.
" } } }, @@ -23504,27 +23514,27 @@ "members":{ "InstanceId":{ "shape":"InstanceId", - "documentation":"", + "documentation":"The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "location":"uri", "locationName":"InstanceId" }, "EmailAddressId":{ "shape":"EmailAddressId", - "documentation":"", + "documentation":"The identifier of the email address.
", "location":"uri", "locationName":"EmailAddressId" }, "Description":{ "shape":"Description", - "documentation":"" + "documentation":"The description of the email address.
" }, "DisplayName":{ "shape":"EmailAddressDisplayName", - "documentation":"" + "documentation":"The display name of email address.
" }, "ClientToken":{ "shape":"ClientToken", - "documentation":"" + "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
" } } }, @@ -23533,11 +23543,11 @@ "members":{ "EmailAddressId":{ "shape":"EmailAddressId", - "documentation":"" + "documentation":"The identifier of the email address.
" }, "EmailAddressArn":{ "shape":"EmailAddressArn", - "documentation":"" + "documentation":"The Amazon Resource Name (ARN) of the email address.
" } } }, @@ -24004,19 +24014,19 @@ "members":{ "InstanceId":{ "shape":"InstanceId", - "documentation":"", + "documentation":"The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", "location":"uri", "locationName":"InstanceId" }, "QueueId":{ "shape":"QueueId", - "documentation":"", + "documentation":"The identifier for the queue.
", "location":"uri", "locationName":"QueueId" }, "OutboundEmailConfig":{ "shape":"OutboundEmailConfig", - "documentation":"" + "documentation":"The outbound email address ID for a specified queue.
" } } }, @@ -24362,7 +24372,7 @@ }, "SelfAssignFlowId":{ "shape":"ContactFlowId", - "documentation":"" + "documentation":"The ContactFlowId for the flow that will be run if this template is used to create a self-assigned task.
" }, "Constraints":{ "shape":"TaskTemplateConstraints", @@ -24411,7 +24421,7 @@ }, "SelfAssignFlowId":{ "shape":"ContactFlowId", - "documentation":"" + "documentation":"The ContactFlowId for the flow that will be run if this template is used to create a self-assigned task.
" }, "Constraints":{ "shape":"TaskTemplateConstraints", @@ -25042,10 +25052,10 @@ "members":{ "UserId":{ "shape":"AgentResourceId", - "documentation":"" + "documentation":"The user identifier for the contact.
" } }, - "documentation":"" + "documentation":"The user details for the contact.
" }, "UserNotFoundException":{ "type":"structure", diff --git a/botocore/data/ec2/2016-11-15/service-2.json b/botocore/data/ec2/2016-11-15/service-2.json index 01fe5b082f..b988267798 100644 --- a/botocore/data/ec2/2016-11-15/service-2.json +++ b/botocore/data/ec2/2016-11-15/service-2.json @@ -5618,7 +5618,7 @@ }, "input":{"shape":"ModifyVpcEndpointServiceConfigurationRequest"}, "output":{"shape":"ModifyVpcEndpointServiceConfigurationResult"}, - "documentation":"Modifies the attributes of your VPC endpoint service configuration. You can change the Network Load Balancers or Gateway Load Balancers for your service, and you can specify whether acceptance is required for requests to connect to your endpoint service through an interface VPC endpoint.
If you set or modify the private DNS name, you must prove that you own the private DNS domain name.
" + "documentation":"Modifies the attributes of the specified VPC endpoint service configuration.
If you set or modify the private DNS name, you must prove that you own the private DNS domain name.
" }, "ModifyVpcEndpointServicePayerResponsibility":{ "name":"ModifyVpcEndpointServicePayerResponsibility", @@ -12349,6 +12349,11 @@ "shape":"ConnectionNotificationState", "documentation":"The state of the notification.
", "locationName":"connectionNotificationState" + }, + "ServiceRegion":{ + "shape":"String", + "documentation":"The Region for the endpoint service.
", + "locationName":"serviceRegion" } }, "documentation":"Describes a connection notification for a VPC endpoint or VPC endpoint service.
" @@ -12696,6 +12701,10 @@ "documentation":"The tags to apply to the new snapshot.
", "locationName":"TagSpecification" }, + "CompletionDurationMinutes":{ + "shape":"SnapshotCompletionDurationMinutesRequest", + "documentation":"Specify a completion duration, in 15 minute increments, to initiate a time-based snapshot copy. Time-based snapshot copy operations complete within the specified duration. For more information, see Time-based copies.
If you do not specify a value, the snapshot copy operation is completed on a best-effort basis.
" + }, "DryRun":{ "shape":"Boolean", "documentation":"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The subnet configurations for the endpoint.
", "locationName":"SubnetConfiguration" + }, + "ServiceRegion":{ + "shape":"String", + "documentation":"The Region where the service is hosted. The default is the current Region.
" } } }, @@ -17001,6 +17014,11 @@ "documentation":"The supported IP address types. The possible values are ipv4 and ipv6.
The Regions from which service consumers can access the service.
", + "locationName":"SupportedRegion" + }, "ClientToken":{ "shape":"String", "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
" @@ -22190,7 +22208,7 @@ }, "Filters":{ "shape":"FilterList", - "documentation":"The filters.
availability-zone - The Availability Zone of the instance.
event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).
event.description - A description of the event.
event.instance-event-id - The ID of the event whose date and time you are modifying.
event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).
event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).
event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z).
instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).
instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).
instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).
system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).
system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).
attached-ebs-status.status - The status of the attached EBS volume for the instance (ok | impaired | initializing | insufficient-data | not-applicable).
The filters.
availability-zone - The Availability Zone of the instance.
event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).
event.description - A description of the event.
event.instance-event-id - The ID of the event whose date and time you are modifying.
event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).
event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).
event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z).
instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).
instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).
instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).
operator.managed - A Boolean that indicates whether this is a managed instance.
operator.principal - The principal that manages the instance. Only valid for managed instances, where managed is true.
system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).
system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).
attached-ebs-status.status - The status of the attached EBS volume for the instance (ok | impaired | initializing | insufficient-data | not-applicable).
The filters.
affinity - The affinity setting for an instance running on a Dedicated Host (default | host).
architecture - The instance architecture (i386 | x86_64 | arm64).
availability-zone - The Availability Zone of the instance.
block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2022-09-15T17:15:20.000Z.
block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination.
block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh).
block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached).
block-device-mapping.volume-id - The volume ID of the EBS volume.
boot-mode - The boot mode that was specified by the AMI (legacy-bios | uefi | uefi-preferred).
capacity-reservation-id - The ID of the Capacity Reservation into which the instance was launched.
capacity-reservation-specification.capacity-reservation-preference - The instance's Capacity Reservation preference (open | none).
capacity-reservation-specification.capacity-reservation-target.capacity-reservation-id - The ID of the targeted Capacity Reservation.
capacity-reservation-specification.capacity-reservation-target.capacity-reservation-resource-group-arn - The ARN of the targeted Capacity Reservation group.
client-token - The idempotency token you provided when you launched the instance.
current-instance-boot-mode - The boot mode that is used to launch the instance at launch or start (legacy-bios | uefi).
dns-name - The public DNS name of the instance.
ebs-optimized - A Boolean that indicates whether the instance is optimized for Amazon EBS I/O.
ena-support - A Boolean that indicates whether the instance is enabled for enhanced networking with ENA.
enclave-options.enabled - A Boolean that indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
hibernation-options.configured - A Boolean that indicates whether the instance is enabled for hibernation. A value of true means that the instance is enabled for hibernation.
host-id - The ID of the Dedicated Host on which the instance is running, if applicable.
hypervisor - The hypervisor type of the instance (ovm | xen). The value xen is used for both Xen and Nitro hypervisors.
iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.
iam-instance-profile.id - The instance profile associated with the instance. Specified as an ID.
image-id - The ID of the image used to launch the instance.
instance-id - The ID of the instance.
instance-lifecycle - Indicates whether this is a Spot Instance, a Scheduled Instance, or a Capacity Block (spot | scheduled | capacity-block).
instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).
instance-type - The type of instance (for example, t2.micro).
instance.group-id - The ID of the security group for the instance.
instance.group-name - The name of the security group for the instance.
ip-address - The public IPv4 address of the instance.
ipv6-address - The IPv6 address of the instance.
kernel-id - The kernel ID.
key-name - The name of the key pair used when the instance was launched.
launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).
launch-time - The time when the instance was launched, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for example, 2021-09-29T*, which matches an entire day.
maintenance-options.auto-recovery - The current automatic recovery behavior of the instance (disabled | default).
metadata-options.http-endpoint - The status of access to the HTTP metadata endpoint on your instance (enabled | disabled)
metadata-options.http-protocol-ipv4 - Indicates whether the IPv4 endpoint is enabled (disabled | enabled).
metadata-options.http-protocol-ipv6 - Indicates whether the IPv6 endpoint is enabled (disabled | enabled).
metadata-options.http-put-response-hop-limit - The HTTP metadata request put response hop limit (integer, possible values 1 to 64)
metadata-options.http-tokens - The metadata request authorization state (optional | required)
metadata-options.instance-metadata-tags - The status of access to instance tags from the instance metadata (enabled | disabled)
metadata-options.state - The state of the metadata option changes (pending | applied).
monitoring-state - Indicates whether detailed monitoring is enabled (disabled | enabled).
network-interface.addresses.association.allocation-id - The allocation ID.
network-interface.addresses.association.association-id - The association ID.
network-interface.addresses.association.carrier-ip - The carrier IP address.
network-interface.addresses.association.customer-owned-ip - The customer-owned IP address.
network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4 address associated with the network interface.
network-interface.addresses.association.public-dns-name - The public DNS name.
network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address (IPv4) with a network interface.
network-interface.addresses.primary - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address.
network-interface.addresses.private-dns-name - The private DNS name.
network-interface.addresses.private-ip-address - The private IPv4 address associated with the network interface.
network-interface.association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
network-interface.association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
network-interface.association.carrier-ip - The customer-owned IP address.
network-interface.association.customer-owned-ip - The customer-owned IP address.
network-interface.association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.
network-interface.association.public-dns-name - The public DNS name.
network-interface.association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
network-interface.attachment.attach-time - The time that the network interface was attached to an instance.
network-interface.attachment.attachment-id - The ID of the interface attachment.
network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.
network-interface.attachment.device-index - The device index to which the network interface is attached.
network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.
network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
network-interface.attachment.network-card-index - The index of the network card.
network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).
network-interface.availability-zone - The Availability Zone for the network interface.
network-interface.deny-all-igw-traffic - A Boolean that indicates whether a network interface with an IPv6 address is unreachable from the public internet.
network-interface.description - The description of the network interface.
network-interface.group-id - The ID of a security group associated with the network interface.
network-interface.group-name - The name of a security group associated with the network interface.
network-interface.ipv4-prefixes.ipv4-prefix - The IPv4 prefixes that are assigned to the network interface.
network-interface.ipv6-address - The IPv6 address associated with the network interface.
network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with the network interface.
network-interface.ipv6-addresses.is-primary-ipv6 - A Boolean that indicates whether this is the primary IPv6 address.
network-interface.ipv6-native - A Boolean that indicates whether this is an IPv6 only network interface.
network-interface.ipv6-prefixes.ipv6-prefix - The IPv6 prefix assigned to the network interface.
network-interface.mac-address - The MAC address of the network interface.
network-interface.network-interface-id - The ID of the network interface.
network-interface.outpost-arn - The ARN of the Outpost.
network-interface.owner-id - The ID of the owner of the network interface.
network-interface.private-dns-name - The private DNS name of the network interface.
network-interface.private-ip-address - The private IPv4 address.
network-interface.public-dns-name - The public DNS name.
network-interface.requester-id - The requester ID for the network interface.
network-interface.requester-managed - Indicates whether the network interface is being managed by Amazon Web Services.
network-interface.status - The status of the network interface (available) | in-use).
network-interface.source-dest-check - Whether the network interface performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
network-interface.subnet-id - The ID of the subnet for the network interface.
network-interface.tag-key - The key of a tag assigned to the network interface.
network-interface.tag-value - The value of a tag assigned to the network interface.
network-interface.vpc-id - The ID of the VPC for the network interface.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
owner-id - The Amazon Web Services account ID of the instance owner.
placement-group-name - The name of the placement group for the instance.
placement-partition-number - The partition in which the instance is located.
platform - The platform. To list only Windows instances, use windows.
platform-details - The platform (Linux/UNIX | Red Hat BYOL Linux | Red Hat Enterprise Linux | Red Hat Enterprise Linux with HA | Red Hat Enterprise Linux with SQL Server Standard and HA | Red Hat Enterprise Linux with SQL Server Enterprise and HA | Red Hat Enterprise Linux with SQL Server Standard | Red Hat Enterprise Linux with SQL Server Web | Red Hat Enterprise Linux with SQL Server Enterprise | SQL Server Enterprise | SQL Server Standard | SQL Server Web | SUSE Linux | Ubuntu Pro | Windows | Windows BYOL | Windows with SQL Server Enterprise | Windows with SQL Server Standard | Windows with SQL Server Web).
private-dns-name - The private IPv4 DNS name of the instance.
private-dns-name-options.enable-resource-name-dns-a-record - A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS A records.
private-dns-name-options.enable-resource-name-dns-aaaa-record - A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
private-dns-name-options.hostname-type - The type of hostname (ip-name | resource-name).
private-ip-address - The private IPv4 address of the instance. This can only be used to filter by the primary IP address of the network interface attached to the instance. To filter by additional IP addresses assigned to the network interface, use the filter network-interface.addresses.private-ip-address.
product-code - The product code associated with the AMI used to launch the instance.
product-code.type - The type of product code (devpay | marketplace).
ramdisk-id - The RAM disk ID.
reason - The reason for the current state of the instance (for example, shows \"User Initiated [date]\" when you stop or terminate the instance). Similar to the state-reason-code filter.
requester-id - The ID of the entity that launched the instance on your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
reservation-id - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation ID.
root-device-name - The device name of the root device volume (for example, /dev/sda1).
root-device-type - The type of the root device volume (ebs | instance-store).
source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.
spot-instance-request-id - The ID of the Spot Instance request.
state-reason-code - The reason code for the state change.
state-reason-message - A message that describes the state change.
subnet-id - The ID of the subnet for the instance.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
tenancy - The tenancy of an instance (dedicated | default | host).
tpm-support - Indicates if the instance is configured for NitroTPM support (v2.0).
usage-operation - The usage operation value for the instance (RunInstances | RunInstances:00g0 | RunInstances:0010 | RunInstances:1010 | RunInstances:1014 | RunInstances:1110 | RunInstances:0014 | RunInstances:0210 | RunInstances:0110 | RunInstances:0100 | RunInstances:0004 | RunInstances:0200 | RunInstances:000g | RunInstances:0g00 | RunInstances:0002 | RunInstances:0800 | RunInstances:0102 | RunInstances:0006 | RunInstances:0202).
usage-operation-update-time - The time that the usage operation was last updated, for example, 2022-09-15T17:15:20.000Z.
virtualization-type - The virtualization type of the instance (paravirtual | hvm).
vpc-id - The ID of the VPC that the instance is running in.
The filters.
affinity - The affinity setting for an instance running on a Dedicated Host (default | host).
architecture - The instance architecture (i386 | x86_64 | arm64).
availability-zone - The Availability Zone of the instance.
block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2022-09-15T17:15:20.000Z.
block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination.
block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh).
block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached).
block-device-mapping.volume-id - The volume ID of the EBS volume.
boot-mode - The boot mode that was specified by the AMI (legacy-bios | uefi | uefi-preferred).
capacity-reservation-id - The ID of the Capacity Reservation into which the instance was launched.
capacity-reservation-specification.capacity-reservation-preference - The instance's Capacity Reservation preference (open | none).
capacity-reservation-specification.capacity-reservation-target.capacity-reservation-id - The ID of the targeted Capacity Reservation.
capacity-reservation-specification.capacity-reservation-target.capacity-reservation-resource-group-arn - The ARN of the targeted Capacity Reservation group.
client-token - The idempotency token you provided when you launched the instance.
current-instance-boot-mode - The boot mode that is used to launch the instance at launch or start (legacy-bios | uefi).
dns-name - The public DNS name of the instance.
ebs-optimized - A Boolean that indicates whether the instance is optimized for Amazon EBS I/O.
ena-support - A Boolean that indicates whether the instance is enabled for enhanced networking with ENA.
enclave-options.enabled - A Boolean that indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
hibernation-options.configured - A Boolean that indicates whether the instance is enabled for hibernation. A value of true means that the instance is enabled for hibernation.
host-id - The ID of the Dedicated Host on which the instance is running, if applicable.
hypervisor - The hypervisor type of the instance (ovm | xen). The value xen is used for both Xen and Nitro hypervisors.
iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.
iam-instance-profile.id - The instance profile associated with the instance. Specified as an ID.
image-id - The ID of the image used to launch the instance.
instance-id - The ID of the instance.
instance-lifecycle - Indicates whether this is a Spot Instance, a Scheduled Instance, or a Capacity Block (spot | scheduled | capacity-block).
instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).
instance-type - The type of instance (for example, t2.micro).
instance.group-id - The ID of the security group for the instance.
instance.group-name - The name of the security group for the instance.
ip-address - The public IPv4 address of the instance.
ipv6-address - The IPv6 address of the instance.
kernel-id - The kernel ID.
key-name - The name of the key pair used when the instance was launched.
launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).
launch-time - The time when the instance was launched, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for example, 2021-09-29T*, which matches an entire day.
maintenance-options.auto-recovery - The current automatic recovery behavior of the instance (disabled | default).
metadata-options.http-endpoint - The status of access to the HTTP metadata endpoint on your instance (enabled | disabled)
metadata-options.http-protocol-ipv4 - Indicates whether the IPv4 endpoint is enabled (disabled | enabled).
metadata-options.http-protocol-ipv6 - Indicates whether the IPv6 endpoint is enabled (disabled | enabled).
metadata-options.http-put-response-hop-limit - The HTTP metadata request put response hop limit (integer, possible values 1 to 64)
metadata-options.http-tokens - The metadata request authorization state (optional | required)
metadata-options.instance-metadata-tags - The status of access to instance tags from the instance metadata (enabled | disabled)
metadata-options.state - The state of the metadata option changes (pending | applied).
monitoring-state - Indicates whether detailed monitoring is enabled (disabled | enabled).
network-interface.addresses.association.allocation-id - The allocation ID.
network-interface.addresses.association.association-id - The association ID.
network-interface.addresses.association.carrier-ip - The carrier IP address.
network-interface.addresses.association.customer-owned-ip - The customer-owned IP address.
network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4 address associated with the network interface.
network-interface.addresses.association.public-dns-name - The public DNS name.
network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address (IPv4) with a network interface.
network-interface.addresses.primary - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address.
network-interface.addresses.private-dns-name - The private DNS name.
network-interface.addresses.private-ip-address - The private IPv4 address associated with the network interface.
network-interface.association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
network-interface.association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
network-interface.association.carrier-ip - The customer-owned IP address.
network-interface.association.customer-owned-ip - The customer-owned IP address.
network-interface.association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.
network-interface.association.public-dns-name - The public DNS name.
network-interface.association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
network-interface.attachment.attach-time - The time that the network interface was attached to an instance.
network-interface.attachment.attachment-id - The ID of the interface attachment.
network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.
network-interface.attachment.device-index - The device index to which the network interface is attached.
network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.
network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
network-interface.attachment.network-card-index - The index of the network card.
network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).
network-interface.availability-zone - The Availability Zone for the network interface.
network-interface.deny-all-igw-traffic - A Boolean that indicates whether a network interface with an IPv6 address is unreachable from the public internet.
network-interface.description - The description of the network interface.
network-interface.group-id - The ID of a security group associated with the network interface.
network-interface.group-name - The name of a security group associated with the network interface.
network-interface.ipv4-prefixes.ipv4-prefix - The IPv4 prefixes that are assigned to the network interface.
network-interface.ipv6-address - The IPv6 address associated with the network interface.
network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with the network interface.
network-interface.ipv6-addresses.is-primary-ipv6 - A Boolean that indicates whether this is the primary IPv6 address.
network-interface.ipv6-native - A Boolean that indicates whether this is an IPv6 only network interface.
network-interface.ipv6-prefixes.ipv6-prefix - The IPv6 prefix assigned to the network interface.
network-interface.mac-address - The MAC address of the network interface.
network-interface.network-interface-id - The ID of the network interface.
network-interface.operator.managed - A Boolean that indicates whether the instance has a managed network interface.
network-interface.operator.principal - The principal that manages the network interface. Only valid for instances with managed network interfaces, where managed is true.
network-interface.outpost-arn - The ARN of the Outpost.
network-interface.owner-id - The ID of the owner of the network interface.
network-interface.private-dns-name - The private DNS name of the network interface.
network-interface.private-ip-address - The private IPv4 address.
network-interface.public-dns-name - The public DNS name.
network-interface.requester-id - The requester ID for the network interface.
network-interface.requester-managed - Indicates whether the network interface is being managed by Amazon Web Services.
network-interface.status - The status of the network interface (available) | in-use).
network-interface.source-dest-check - Whether the network interface performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
network-interface.subnet-id - The ID of the subnet for the network interface.
network-interface.tag-key - The key of a tag assigned to the network interface.
network-interface.tag-value - The value of a tag assigned to the network interface.
network-interface.vpc-id - The ID of the VPC for the network interface.
operator.managed - A Boolean that indicates whether this is a managed instance.
operator.principal - The principal that manages the instance. Only valid for managed instances, where managed is true.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
owner-id - The Amazon Web Services account ID of the instance owner.
placement-group-name - The name of the placement group for the instance.
placement-partition-number - The partition in which the instance is located.
platform - The platform. To list only Windows instances, use windows.
platform-details - The platform (Linux/UNIX | Red Hat BYOL Linux | Red Hat Enterprise Linux | Red Hat Enterprise Linux with HA | Red Hat Enterprise Linux with SQL Server Standard and HA | Red Hat Enterprise Linux with SQL Server Enterprise and HA | Red Hat Enterprise Linux with SQL Server Standard | Red Hat Enterprise Linux with SQL Server Web | Red Hat Enterprise Linux with SQL Server Enterprise | SQL Server Enterprise | SQL Server Standard | SQL Server Web | SUSE Linux | Ubuntu Pro | Windows | Windows BYOL | Windows with SQL Server Enterprise | Windows with SQL Server Standard | Windows with SQL Server Web).
private-dns-name - The private IPv4 DNS name of the instance.
private-dns-name-options.enable-resource-name-dns-a-record - A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS A records.
private-dns-name-options.enable-resource-name-dns-aaaa-record - A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
private-dns-name-options.hostname-type - The type of hostname (ip-name | resource-name).
private-ip-address - The private IPv4 address of the instance. This can only be used to filter by the primary IP address of the network interface attached to the instance. To filter by additional IP addresses assigned to the network interface, use the filter network-interface.addresses.private-ip-address.
product-code - The product code associated with the AMI used to launch the instance.
product-code.type - The type of product code (devpay | marketplace).
ramdisk-id - The RAM disk ID.
reason - The reason for the current state of the instance (for example, shows \"User Initiated [date]\" when you stop or terminate the instance). Similar to the state-reason-code filter.
requester-id - The ID of the entity that launched the instance on your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
reservation-id - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation ID.
root-device-name - The device name of the root device volume (for example, /dev/sda1).
root-device-type - The type of the root device volume (ebs | instance-store).
source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.
spot-instance-request-id - The ID of the Spot Instance request.
state-reason-code - The reason code for the state change.
state-reason-message - A message that describes the state change.
subnet-id - The ID of the subnet for the instance.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
tenancy - The tenancy of an instance (dedicated | default | host).
tpm-support - Indicates if the instance is configured for NitroTPM support (v2.0).
usage-operation - The usage operation value for the instance (RunInstances | RunInstances:00g0 | RunInstances:0010 | RunInstances:1010 | RunInstances:1014 | RunInstances:1110 | RunInstances:0014 | RunInstances:0210 | RunInstances:0110 | RunInstances:0100 | RunInstances:0004 | RunInstances:0200 | RunInstances:000g | RunInstances:0g00 | RunInstances:0002 | RunInstances:0800 | RunInstances:0102 | RunInstances:0006 | RunInstances:0202).
usage-operation-update-time - The time that the usage operation was last updated, for example, 2022-09-15T17:15:20.000Z.
virtualization-type - The virtualization type of the instance (paravirtual | hvm).
vpc-id - The ID of the VPC that the instance is running in.
One or more filters.
association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
addresses.association.owner-id - The owner ID of the addresses associated with the network interface.
addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address (IPv4).
addresses.primary - Whether the private IPv4 address is the primary IP address associated with the network interface.
addresses.private-ip-address - The private IPv4 addresses associated with the network interface.
association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.
association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
association.public-dns-name - The public DNS name for the network interface (IPv4).
attachment.attach-time - The time that the network interface was attached to an instance.
attachment.attachment-id - The ID of the interface attachment.
attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.
attachment.device-index - The device index to which the network interface is attached.
attachment.instance-id - The ID of the instance to which the network interface is attached.
attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
attachment.status - The status of the attachment (attaching | attached | detaching | detached).
availability-zone - The Availability Zone of the network interface.
description - The description of the network interface.
group-id - The ID of a security group associated with the network interface.
ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.
interface-type - The type of network interface (api_gateway_managed | aws_codestar_connections_managed | branch | ec2_instance_connect_endpoint | efa | efa-only | efs | gateway_load_balancer | gateway_load_balancer_endpoint | global_accelerator_managed | interface | iot_rules_managed | lambda | load_balancer | nat_gateway | network_load_balancer | quicksight | transit_gateway | trunk | vpc_endpoint).
mac-address - The MAC address of the network interface.
network-interface-id - The ID of the network interface.
owner-id - The Amazon Web Services account ID of the network interface owner.
private-dns-name - The private DNS name of the network interface (IPv4).
private-ip-address - The private IPv4 address or addresses of the network interface.
requester-id - The alias or Amazon Web Services account ID of the principal or service that created the network interface.
requester-managed - Indicates whether the network interface is being managed by an Amazon Web Services service (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
source-dest-check - Indicates whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
status - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.
subnet-id - The ID of the subnet for the network interface.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the network interface.
One or more filters.
association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
addresses.association.owner-id - The owner ID of the addresses associated with the network interface.
addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address (IPv4).
addresses.primary - Whether the private IPv4 address is the primary IP address associated with the network interface.
addresses.private-ip-address - The private IPv4 addresses associated with the network interface.
association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.
association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
association.public-dns-name - The public DNS name for the network interface (IPv4).
attachment.attach-time - The time that the network interface was attached to an instance.
attachment.attachment-id - The ID of the interface attachment.
attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.
attachment.device-index - The device index to which the network interface is attached.
attachment.instance-id - The ID of the instance to which the network interface is attached.
attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
attachment.status - The status of the attachment (attaching | attached | detaching | detached).
availability-zone - The Availability Zone of the network interface.
description - The description of the network interface.
group-id - The ID of a security group associated with the network interface.
ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.
interface-type - The type of network interface (api_gateway_managed | aws_codestar_connections_managed | branch | ec2_instance_connect_endpoint | efa | efa-only | efs | gateway_load_balancer | gateway_load_balancer_endpoint | global_accelerator_managed | interface | iot_rules_managed | lambda | load_balancer | nat_gateway | network_load_balancer | quicksight | transit_gateway | trunk | vpc_endpoint).
mac-address - The MAC address of the network interface.
network-interface-id - The ID of the network interface.
operator.managed - A Boolean that indicates whether this is a managed network interface.
operator.principal - The principal that manages the network interface. Only valid for managed network interfaces, where managed is true.
owner-id - The Amazon Web Services account ID of the network interface owner.
private-dns-name - The private DNS name of the network interface (IPv4).
private-ip-address - The private IPv4 address or addresses of the network interface.
requester-id - The alias or Amazon Web Services account ID of the principal or service that created the network interface.
requester-managed - Indicates whether the network interface is being managed by an Amazon Web Services service (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
source-dest-check - Indicates whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
status - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.
subnet-id - The ID of the subnet for the network interface.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the network interface.
The filters.
attachment.attach-time - The time stamp when the attachment initiated.
attachment.delete-on-termination - Whether the volume is deleted on instance termination.
attachment.device - The device name specified in the block device mapping (for example, /dev/sda1).
attachment.instance-id - The ID of the instance the volume is attached to.
attachment.status - The attachment state (attaching | attached | detaching).
availability-zone - The Availability Zone in which the volume was created.
create-time - The time stamp when the volume was created.
encrypted - Indicates whether the volume is encrypted (true | false)
multi-attach-enabled - Indicates whether the volume is enabled for Multi-Attach (true | false)
fast-restored - Indicates whether the volume was created from a snapshot that is enabled for fast snapshot restore (true | false).
size - The size of the volume, in GiB.
snapshot-id - The snapshot from which the volume was created.
status - The state of the volume (creating | available | in-use | deleting | deleted | error).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
volume-id - The volume ID.
volume-type - The Amazon EBS volume type (gp2 | gp3 | io1 | io2 | st1 | sc1| standard)
The filters.
attachment.attach-time - The time stamp when the attachment initiated.
attachment.delete-on-termination - Whether the volume is deleted on instance termination.
attachment.device - The device name specified in the block device mapping (for example, /dev/sda1).
attachment.instance-id - The ID of the instance the volume is attached to.
attachment.status - The attachment state (attaching | attached | detaching).
availability-zone - The Availability Zone in which the volume was created.
create-time - The time stamp when the volume was created.
encrypted - Indicates whether the volume is encrypted (true | false)
fast-restored - Indicates whether the volume was created from a snapshot that is enabled for fast snapshot restore (true | false).
multi-attach-enabled - Indicates whether the volume is enabled for Multi-Attach (true | false)
operator.managed - A Boolean that indicates whether this is a managed volume.
operator.principal - The principal that manages the volume. Only valid for managed volumes, where managed is true.
size - The size of the volume, in GiB.
snapshot-id - The snapshot from which the volume was created.
status - The state of the volume (creating | available | in-use | deleting | deleted | error).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
volume-id - The volume ID.
volume-type - The Amazon EBS volume type (gp2 | gp3 | io1 | io2 | st1 | sc1| standard)
The filters.
ip-address-type - The IP address type (ipv4 | ipv6).
service-id - The ID of the service.
vpc-endpoint-owner - The ID of the Amazon Web Services account ID that owns the endpoint.
vpc-endpoint-state - The state of the endpoint (pendingAcceptance | pending | available | deleting | deleted | rejected | failed).
vpc-endpoint-id - The ID of the endpoint.
The filters.
ip-address-type - The IP address type (ipv4 | ipv6).
service-id - The ID of the service.
vpc-endpoint-owner - The ID of the Amazon Web Services account ID that owns the endpoint.
vpc-endpoint-region - The Region of the endpoint or cross-region to find endpoints for other Regions.
vpc-endpoint-state - The state of the endpoint (pendingAcceptance | pending | available | deleting | deleted | rejected | failed).
vpc-endpoint-id - The ID of the endpoint.
The filters.
owner - The ID or alias of the Amazon Web Services account that owns the service.
service-name - The name of the service.
service-type - The type of service (Interface | Gateway | GatewayLoadBalancer).
supported-ip-address-types - The IP address type (ipv4 | ipv6).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The filters.
owner - The ID or alias of the Amazon Web Services account that owns the service.
service-name - The name of the service.
service-region - The Region of the service.
service-type - The type of service (Interface | Gateway | GatewayLoadBalancer).
supported-ip-address-types - The IP address type (ipv4 | ipv6).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The token for the next set of items to return. (You received this token from a prior call.)
" + }, + "ServiceRegions":{ + "shape":"ValueStringList", + "documentation":"The service Regions.
", + "locationName":"ServiceRegion" } } }, @@ -26649,7 +26672,7 @@ }, "Filters":{ "shape":"FilterList", - "documentation":"The filters.
ip-address-type - The IP address type (ipv4 | ipv6).
service-name - The name of the service.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC in which the endpoint resides.
vpc-endpoint-id - The ID of the endpoint.
vpc-endpoint-state - The state of the endpoint (pendingAcceptance | pending | available | deleting | deleted | rejected | failed).
vpc-endpoint-type - The type of VPC endpoint (Interface | Gateway | GatewayLoadBalancer).
The filters.
ip-address-type - The IP address type (ipv4 | ipv6).
service-name - The name of the service.
service-region - The Region of the service.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC in which the endpoint resides.
vpc-endpoint-id - The ID of the endpoint.
vpc-endpoint-state - The state of the endpoint (pendingAcceptance | pending | available | deleting | deleted | rejected | failed).
vpc-endpoint-type - The type of VPC endpoint (Interface | Gateway | GatewayLoadBalancer).
The CPU manufacturers to include.
For instance types with Intel CPUs, specify intel.
For instance types with AMD CPUs, specify amd.
For instance types with Amazon Web Services CPUs, specify amazon-web-services.
Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.
Default: Any manufacturer
", + "documentation":"The CPU manufacturers to include.
For instance types with Intel CPUs, specify intel.
For instance types with AMD CPUs, specify amd.
For instance types with Amazon Web Services CPUs, specify amazon-web-services.
For instance types with Apple CPUs, specify apple.
Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.
Default: Any manufacturer
", "locationName":"cpuManufacturerSet" }, "MemoryGiBPerVCpu":{ @@ -37479,7 +37502,7 @@ }, "CpuManufacturers":{ "shape":"CpuManufacturerSet", - "documentation":"The CPU manufacturers to include.
For instance types with Intel CPUs, specify intel.
For instance types with AMD CPUs, specify amd.
For instance types with Amazon Web Services CPUs, specify amazon-web-services.
Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.
Default: Any manufacturer
", + "documentation":"The CPU manufacturers to include.
For instance types with Intel CPUs, specify intel.
For instance types with AMD CPUs, specify amd.
For instance types with Amazon Web Services CPUs, specify amazon-web-services.
For instance types with Apple CPUs, specify apple.
Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.
Default: Any manufacturer
", "locationName":"CpuManufacturer" }, "MemoryGiBPerVCpu":{ @@ -41402,7 +41425,7 @@ "members":{ "CapacityReservationPreference":{ "shape":"CapacityReservationPreference", - "documentation":"Indicates the instance's Capacity Reservation preferences. Possible preferences include:
open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.
Indicates the instance's Capacity Reservation preferences. Possible preferences include:
capacity-reservations-only - The instance will only run in a Capacity Reservation or Capacity Reservation group. If capacity isn't available, the instance will fail to launch.
open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone, tenancy).
none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.
Indicates whether requests to create an endpoint to your service must be accepted.
" + "documentation":"Indicates whether requests to create an endpoint to the service must be accepted.
" }, "AddNetworkLoadBalancerArns":{ "shape":"ValueStringList", - "documentation":"The Amazon Resource Names (ARNs) of Network Load Balancers to add to your service configuration.
", + "documentation":"The Amazon Resource Names (ARNs) of Network Load Balancers to add to the service configuration.
", "locationName":"AddNetworkLoadBalancerArn" }, "RemoveNetworkLoadBalancerArns":{ "shape":"ValueStringList", - "documentation":"The Amazon Resource Names (ARNs) of Network Load Balancers to remove from your service configuration.
", + "documentation":"The Amazon Resource Names (ARNs) of Network Load Balancers to remove from the service configuration.
", "locationName":"RemoveNetworkLoadBalancerArn" }, "AddGatewayLoadBalancerArns":{ "shape":"ValueStringList", - "documentation":"The Amazon Resource Names (ARNs) of Gateway Load Balancers to add to your service configuration.
", + "documentation":"The Amazon Resource Names (ARNs) of Gateway Load Balancers to add to the service configuration.
", "locationName":"AddGatewayLoadBalancerArn" }, "RemoveGatewayLoadBalancerArns":{ "shape":"ValueStringList", - "documentation":"The Amazon Resource Names (ARNs) of Gateway Load Balancers to remove from your service configuration.
", + "documentation":"The Amazon Resource Names (ARNs) of Gateway Load Balancers to remove from the service configuration.
", "locationName":"RemoveGatewayLoadBalancerArn" }, "AddSupportedIpAddressTypes":{ "shape":"ValueStringList", - "documentation":"The IP address types to add to your service configuration.
", + "documentation":"The IP address types to add to the service configuration.
", "locationName":"AddSupportedIpAddressType" }, "RemoveSupportedIpAddressTypes":{ "shape":"ValueStringList", - "documentation":"The IP address types to remove from your service configuration.
", + "documentation":"The IP address types to remove from the service configuration.
", "locationName":"RemoveSupportedIpAddressType" + }, + "AddSupportedRegions":{ + "shape":"ValueStringList", + "documentation":"The supported Regions to add to the service configuration.
", + "locationName":"AddSupportedRegion" + }, + "RemoveSupportedRegions":{ + "shape":"ValueStringList", + "documentation":"The supported Regions to remove from the service configuration.
", + "locationName":"RemoveSupportedRegion" } } }, @@ -55512,6 +55545,16 @@ "shape":"TagList", "documentation":"The tags assigned to the service.
", "locationName":"tagSet" + }, + "SupportedRegions":{ + "shape":"SupportedRegionSet", + "documentation":"The supported Regions.
", + "locationName":"supportedRegionSet" + }, + "RemoteAccessEnabled":{ + "shape":"Boolean", + "documentation":"Indicates whether consumers can access the service from a Region other than the Region where the service is hosted.
", + "locationName":"remoteAccessEnabled" } }, "documentation":"Describes a service configuration for a VPC endpoint service.
" @@ -55548,6 +55591,11 @@ "documentation":"The type of service.
", "locationName":"serviceType" }, + "ServiceRegion":{ + "shape":"String", + "documentation":"The Region where the service is hosted.
", + "locationName":"serviceRegion" + }, "AvailabilityZones":{ "shape":"ValueStringList", "documentation":"The Availability Zones in which the service is available.
", @@ -55726,6 +55774,21 @@ "documentation":"Reserved for future use.
", "locationName":"sseType" }, + "TransferType":{ + "shape":"TransferType", + "documentation":"Only for snapshot copies.
Indicates whether the snapshot copy was created with a standard or time-based snapshot copy operation. Time-based snapshot copy operations complete within the completion duration specified in the request. Standard snapshot copy operations are completed on a best-effort basis.
standard - The snapshot copy was created with a standard snapshot copy operation.
time-based - The snapshot copy was created with a time-based snapshot copy operation.
Only for snapshot copies created with time-based snapshot copy operations.
The completion duration requested for the time-based snapshot copy operation.
", + "locationName":"completionDurationMinutes" + }, + "CompletionTime":{ + "shape":"MillisecondDateTime", + "documentation":"The time stamp when the snapshot was completed.
", + "locationName":"completionTime" + }, "SnapshotId":{ "shape":"String", "documentation":"The ID of the snapshot. Each snapshot receives a unique identifier when it is created.
", @@ -55804,6 +55867,12 @@ "unblocked" ] }, + "SnapshotCompletionDurationMinutesRequest":{ + "type":"integer", + "max":2880, + "min":1 + }, + "SnapshotCompletionDurationMinutesResponse":{"type":"integer"}, "SnapshotDetail":{ "type":"structure", "members":{ @@ -57765,6 +57834,29 @@ "max":2, "min":0 }, + "SupportedRegionDetail":{ + "type":"structure", + "members":{ + "Region":{ + "shape":"String", + "documentation":"The Region code.
", + "locationName":"region" + }, + "ServiceState":{ + "shape":"String", + "documentation":"The service state. The possible values are Pending, Available, Deleting, Deleted, Failed, and Closed.
Describes a supported Region.
" + }, + "SupportedRegionSet":{ + "type":"list", + "member":{ + "shape":"SupportedRegionDetail", + "locationName":"item" + } + }, "Tag":{ "type":"structure", "members":{ @@ -58633,6 +58725,13 @@ "ALL" ] }, + "TransferType":{ + "type":"string", + "enum":[ + "time-based", + "standard" + ] + }, "TransitAssociationGatewayId":{"type":"string"}, "TransitGateway":{ "type":"structure", @@ -62828,6 +62927,11 @@ "shape":"LastError", "documentation":"The last error that occurred for endpoint.
", "locationName":"lastError" + }, + "ServiceRegion":{ + "shape":"String", + "documentation":"The Region where the service is hosted.
", + "locationName":"serviceRegion" } }, "documentation":"Describes a VPC endpoint.
" @@ -62889,6 +62993,11 @@ "shape":"TagList", "documentation":"The tags.
", "locationName":"tagSet" + }, + "VpcEndpointRegion":{ + "shape":"String", + "documentation":"The Region of the endpoint.
", + "locationName":"vpcEndpointRegion" } }, "documentation":"Describes a VPC endpoint connection to a service.
" diff --git a/botocore/data/qapps/2023-11-27/service-2.json b/botocore/data/qapps/2023-11-27/service-2.json index a2bf087de1..c0e097ff34 100644 --- a/botocore/data/qapps/2023-11-27/service-2.json +++ b/botocore/data/qapps/2023-11-27/service-2.json @@ -129,6 +129,24 @@ ], "documentation":"Creates a new library item for an Amazon Q App, allowing it to be discovered and used by other allowed users.
" }, + "CreatePresignedUrl":{ + "name":"CreatePresignedUrl", + "http":{ + "method":"POST", + "requestUri":"/apps.createPresignedUrl", + "responseCode":200 + }, + "input":{"shape":"CreatePresignedUrlInput"}, + "output":{"shape":"CreatePresignedUrlOutput"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Creates a presigned URL for an S3 POST operation to upload a file. You can use this URL to set a default file for a FileUploadCard in a Q App definition or to provide a file for a single Q App run. The scope parameter determines how the file will be used, either at the app definition level or the app session level.
Deletes an Amazon Q App owned by the user. If the Q App was previously published to the library, it is also removed from the library.
", "idempotent":true }, + "DescribeQAppPermissions":{ + "name":"DescribeQAppPermissions", + "http":{ + "method":"GET", + "requestUri":"/apps.describeQAppPermissions", + "responseCode":200 + }, + "input":{"shape":"DescribeQAppPermissionsInput"}, + "output":{"shape":"DescribeQAppPermissionsOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Describes read permissions for a Amazon Q App in Amazon Q Business application environment instance.
" + }, "DisassociateLibraryItemReview":{ "name":"DisassociateLibraryItemReview", "http":{ @@ -227,6 +264,27 @@ ], "documentation":"Disassociates a Q App from a user removing the user's access to run the Q App.
" }, + "ExportQAppSessionData":{ + "name":"ExportQAppSessionData", + "http":{ + "method":"POST", + "requestUri":"/runtime.exportQAppSessionData", + "responseCode":200 + }, + "input":{"shape":"ExportQAppSessionDataInput"}, + "output":{"shape":"ExportQAppSessionDataOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Exports the collected data of a Q App data collection session.
" + }, "GetLibraryItem":{ "name":"GetLibraryItem", "http":{ @@ -285,6 +343,26 @@ ], "documentation":"Retrieves the current state and results for an active session of an Amazon Q App.
" }, + "GetQAppSessionMetadata":{ + "name":"GetQAppSessionMetadata", + "http":{ + "method":"GET", + "requestUri":"/runtime.getQAppSessionMetadata", + "responseCode":200 + }, + "input":{"shape":"GetQAppSessionMetadataInput"}, + "output":{"shape":"GetQAppSessionMetadataOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Retrieves the current configuration of a Q App session.
" + }, "ImportDocument":{ "name":"ImportDocument", "http":{ @@ -344,6 +422,26 @@ ], "documentation":"Lists the library items for Amazon Q Apps that are published and available for users in your Amazon Web Services account.
" }, + "ListQAppSessionData":{ + "name":"ListQAppSessionData", + "http":{ + "method":"GET", + "requestUri":"/runtime.listQAppSessionData", + "responseCode":200 + }, + "input":{"shape":"ListQAppSessionDataInput"}, + "output":{"shape":"ListQAppSessionDataOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Lists the collected data of a Q App data collection session.
" + }, "ListQApps":{ "name":"ListQApps", "http":{ @@ -536,6 +634,25 @@ ], "documentation":"Updates an existing Amazon Q App, allowing modifications to its title, description, and definition.
" }, + "UpdateQAppPermissions":{ + "name":"UpdateQAppPermissions", + "http":{ + "method":"POST", + "requestUri":"/apps.updateQAppPermissions", + "responseCode":200 + }, + "input":{"shape":"UpdateQAppPermissionsInput"}, + "output":{"shape":"UpdateQAppPermissionsOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Updates read permissions for a Amazon Q App in Amazon Q Business application environment instance.
" + }, "UpdateQAppSession":{ "name":"UpdateQAppSession", "http":{ @@ -555,6 +672,26 @@ {"shape":"ThrottlingException"} ], "documentation":"Updates the session for a given Q App sessionId. This is only valid when at least one card of the session is in the WAITING state. Data for each WAITING card can be provided as input. If inputs are not provided, the call will be accepted but session will not move forward. Inputs for cards that are not in the WAITING status will be ignored.
Updates the configuration metadata of a session for a given Q App sessionId.
A container for the properties of the file upload card.
" + }, + "formInput":{ + "shape":"FormInputCard", + "documentation":"A container for the properties of the form input card.
" } }, "documentation":"A card representing a component or step in an Amazon Q App's flow.
", @@ -868,6 +1009,10 @@ "fileUpload":{ "shape":"FileUploadCardInput", "documentation":"A container for the properties of the file upload input card.
" + }, + "formInput":{ + "shape":"FormInputCardInput", + "documentation":"A container for the properties of the form input card.
" } }, "documentation":"The properties defining an input card in an Amazon Q App.
", @@ -906,6 +1051,10 @@ "currentValue":{ "shape":"String", "documentation":"The current value or result associated with the card.
" + }, + "submissions":{ + "shape":"SubmissionList", + "documentation":"A list of previous submissions, if the card is a form card.
" } }, "documentation":"The current status and value of a card in an active Amazon Q App session.
" @@ -921,7 +1070,8 @@ "text-input", "q-query", "file-upload", - "q-plugin" + "q-plugin", + "form-input" ] }, "CardValue":{ @@ -938,6 +1088,10 @@ "value":{ "shape":"CardValueValueString", "documentation":"The value or result associated with the card.
" + }, + "submissionMutation":{ + "shape":"SubmissionMutation", + "documentation":"The structure that describes how the current form card value is mutated. Only applies for form cards when multiple responses are allowed.
" } }, "documentation":"The value or result associated with a card in a Amazon Q App session.
" @@ -950,7 +1104,7 @@ }, "CardValueValueString":{ "type":"string", - "max":5000, + "max":40000, "min":0 }, "CategoriesList":{ @@ -1183,6 +1337,80 @@ } } }, + "CreatePresignedUrlInput":{ + "type":"structure", + "required":[ + "instanceId", + "cardId", + "appId", + "fileContentsSha256", + "fileName", + "scope" + ], + "members":{ + "instanceId":{ + "shape":"InstanceId", + "documentation":"The unique identifier of the Amazon Q Business application environment instance.
", + "location":"header", + "locationName":"instance-id" + }, + "cardId":{ + "shape":"UUID", + "documentation":"The unique identifier of the card the file is associated with.
" + }, + "appId":{ + "shape":"UUID", + "documentation":"The unique identifier of the Q App the file is associated with.
" + }, + "fileContentsSha256":{ + "shape":"CreatePresignedUrlInputFileContentsSha256String", + "documentation":"The Base64-encoded SHA-256 digest of the contents of the file to be uploaded.
" + }, + "fileName":{ + "shape":"Filename", + "documentation":"The name of the file to be uploaded.
" + }, + "scope":{ + "shape":"DocumentScope", + "documentation":"Whether the file is associated with a Q App definition or a specific Q App session.
" + }, + "sessionId":{ + "shape":"UUID", + "documentation":"The unique identifier of the Q App session the file is associated with, if applicable.
" + } + } + }, + "CreatePresignedUrlInputFileContentsSha256String":{ + "type":"string", + "pattern":"[A-Za-z0-9+/]{43}=$|^[A-Za-z0-9+/]{42}==$|^[A-Za-z0-9+/]{44}" + }, + "CreatePresignedUrlOutput":{ + "type":"structure", + "required":[ + "fileId", + "presignedUrl", + "presignedUrlFields", + "presignedUrlExpiration" + ], + "members":{ + "fileId":{ + "shape":"String", + "documentation":"The unique identifier assigned to the file to be uploaded.
" + }, + "presignedUrl":{ + "shape":"String", + "documentation":"The URL for a presigned S3 POST operation used to upload a file.
" + }, + "presignedUrlFields":{ + "shape":"PresignedUrlFields", + "documentation":"The form fields to include in the presigned S3 POST operation used to upload a file.
" + }, + "presignedUrlExpiration":{ + "shape":"QAppsTimestamp", + "documentation":"The date and time that the presigned URL will expire in ISO 8601 format.
" + } + } + }, "CreateQAppInput":{ "type":"structure", "required":[ @@ -1332,6 +1560,44 @@ "type":"list", "member":{"shape":"String"} }, + "DescribeQAppPermissionsInput":{ + "type":"structure", + "required":[ + "instanceId", + "appId" + ], + "members":{ + "instanceId":{ + "shape":"InstanceId", + "documentation":"The unique identifier of the Amazon Q Business application environment instance.
", + "location":"header", + "locationName":"instance-id" + }, + "appId":{ + "shape":"UUID", + "documentation":"The unique identifier of the Amazon Q App for which to retrieve permissions.
", + "location":"querystring", + "locationName":"appId" + } + } + }, + "DescribeQAppPermissionsOutput":{ + "type":"structure", + "members":{ + "resourceArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the Amazon Q App for which permissions are returned.
" + }, + "appId":{ + "shape":"String", + "documentation":"The unique identifier of the Amazon Q App for which permissions are returned.
" + }, + "permissions":{ + "shape":"PermissionsOutputList", + "documentation":"The list of permissions granted for the Amazon Q App.
" + } + } + }, "Description":{ "type":"string", "max":500, @@ -1375,6 +1641,12 @@ } } }, + "Document":{ + "type":"structure", + "members":{ + }, + "document":true + }, "DocumentAttribute":{ "type":"structure", "required":[ @@ -1443,9 +1715,51 @@ "enum":[ "IN_PROGRESS", "WAITING", - "COMPLETED" + "COMPLETED", + "ERROR" ] }, + "ExportQAppSessionDataInput":{ + "type":"structure", + "required":[ + "instanceId", + "sessionId" + ], + "members":{ + "instanceId":{ + "shape":"InstanceId", + "documentation":"The unique identifier of the Amazon Q Business application environment instance.
", + "location":"header", + "locationName":"instance-id" + }, + "sessionId":{ + "shape":"UUID", + "documentation":"The unique identifier of the Q App data collection session.
" + } + } + }, + "ExportQAppSessionDataOutput":{ + "type":"structure", + "required":[ + "csvFileLink", + "expiresAt", + "sessionArn" + ], + "members":{ + "csvFileLink":{ + "shape":"String", + "documentation":"The link where the exported Q App session data can be downloaded from.
" + }, + "expiresAt":{ + "shape":"QAppsTimestamp", + "documentation":"The date and time when the link for the exported Q App session data expires.
" + }, + "sessionArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the Q App data collection session.
" + } + } + }, "FileUploadCard":{ "type":"structure", "required":[ @@ -1526,41 +1840,127 @@ "max":100, "min":0 }, - "GetLibraryItemInput":{ + "FormInputCard":{ "type":"structure", "required":[ - "instanceId", - "libraryItemId" + "id", + "title", + "dependencies", + "type", + "metadata" ], "members":{ - "instanceId":{ - "shape":"InstanceId", - "documentation":"The unique identifier of the Amazon Q Business application environment instance.
", - "location":"header", - "locationName":"instance-id" - }, - "libraryItemId":{ + "id":{ "shape":"UUID", - "documentation":"The unique identifier of the library item to retrieve.
", - "location":"querystring", - "locationName":"libraryItemId" + "documentation":"The unique identifier of the form input card.
" }, - "appId":{ - "shape":"UUID", - "documentation":"The unique identifier of the Amazon Q App associated with the library item.
", - "location":"querystring", - "locationName":"appId" + "title":{ + "shape":"Title", + "documentation":"The title of the form input card.
" + }, + "dependencies":{ + "shape":"DependencyList", + "documentation":"Any dependencies or requirements for the form input card.
" + }, + "type":{ + "shape":"CardType", + "documentation":"The type of the card.
" + }, + "metadata":{ + "shape":"FormInputCardMetadata", + "documentation":"The metadata that defines the form input card data.
" + }, + "computeMode":{ + "shape":"InputCardComputeMode", + "documentation":"The compute mode of the form input card. This property determines whether individual participants of a data collection session can submit multiple response or one response. A compute mode of append shall allow participants to submit the same form multiple times with different values. A compute mode of replacecode> shall overwrite the current value for each participant.
A card in an Amazon Q App that allows the user to submit a response.
" }, - "GetLibraryItemOutput":{ + "FormInputCardInput":{ "type":"structure", "required":[ - "libraryItemId", - "appId", - "appVersion", - "categories", - "status", + "title", + "id", + "type", + "metadata" + ], + "members":{ + "title":{ + "shape":"Title", + "documentation":"The title or label of the form input card.
" + }, + "id":{ + "shape":"UUID", + "documentation":"The unique identifier of the form input card.
" + }, + "type":{ + "shape":"CardType", + "documentation":"The type of the card.
" + }, + "metadata":{ + "shape":"FormInputCardMetadata", + "documentation":"The metadata that defines the form input card data.
" + }, + "computeMode":{ + "shape":"InputCardComputeMode", + "documentation":"The compute mode of the form input card. This property determines whether individual participants of a data collection session can submit multiple response or one response. A compute mode of append shall allow participants to submit the same form multiple times with different values. A compute mode of replacecode> shall overwrite the current value for each participant.
Represents a form input card for an Amazon Q App.
" + }, + "FormInputCardMetadata":{ + "type":"structure", + "required":["schema"], + "members":{ + "schema":{ + "shape":"FormInputCardMetadataSchema", + "documentation":"The JSON schema that defines the shape of the response data.
" + } + }, + "documentation":"The metadata of the form input card.
" + }, + "FormInputCardMetadataSchema":{ + "type":"structure", + "members":{ + }, + "document":true + }, + "GetLibraryItemInput":{ + "type":"structure", + "required":[ + "instanceId", + "libraryItemId" + ], + "members":{ + "instanceId":{ + "shape":"InstanceId", + "documentation":"The unique identifier of the Amazon Q Business application environment instance.
", + "location":"header", + "locationName":"instance-id" + }, + "libraryItemId":{ + "shape":"UUID", + "documentation":"The unique identifier of the library item to retrieve.
", + "location":"querystring", + "locationName":"libraryItemId" + }, + "appId":{ + "shape":"UUID", + "documentation":"The unique identifier of the Amazon Q App associated with the library item.
", + "location":"querystring", + "locationName":"appId" + } + } + }, + "GetLibraryItemOutput":{ + "type":"structure", + "required":[ + "libraryItemId", + "appId", + "appVersion", + "categories", + "status", "createdAt", "createdBy", "ratingCount" @@ -1638,6 +2038,12 @@ "documentation":"The unique identifier of the Q App to retrieve.
", "location":"querystring", "locationName":"appId" + }, + "appVersion":{ + "shape":"AppVersion", + "documentation":"The version of the Q App.
", + "location":"querystring", + "locationName":"appVersion" } } }, @@ -1731,6 +2137,57 @@ } } }, + "GetQAppSessionMetadataInput":{ + "type":"structure", + "required":[ + "instanceId", + "sessionId" + ], + "members":{ + "instanceId":{ + "shape":"InstanceId", + "documentation":"The unique identifier of the Amazon Q Business application environment instance.
", + "location":"header", + "locationName":"instance-id" + }, + "sessionId":{ + "shape":"UUID", + "documentation":"The unique identifier of the Q App session.
", + "location":"querystring", + "locationName":"sessionId" + } + } + }, + "GetQAppSessionMetadataOutput":{ + "type":"structure", + "required":[ + "sessionId", + "sessionArn", + "sharingConfiguration" + ], + "members":{ + "sessionId":{ + "shape":"UUID", + "documentation":"The unique identifier of the Q App session.
" + }, + "sessionArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the Q App session.
" + }, + "sessionName":{ + "shape":"SessionName", + "documentation":"The name of the Q App session.
" + }, + "sharingConfiguration":{ + "shape":"SessionSharingConfiguration", + "documentation":"The sharing configuration of the Q App data collection session.
" + }, + "sessionOwner":{ + "shape":"Boolean", + "documentation":"Indicates whether the current user is the owner of the Q App session.
" + } + } + }, "GetQAppSessionOutput":{ "type":"structure", "required":[ @@ -1748,6 +2205,18 @@ "shape":"String", "documentation":"The Amazon Resource Name (ARN) of the Q App session.
" }, + "sessionName":{ + "shape":"SessionName", + "documentation":"The name of the Q App session.
" + }, + "appVersion":{ + "shape":"AppVersion", + "documentation":"The version of the Q App used for the session.
" + }, + "latestPublishedAppVersion":{ + "shape":"AppVersion", + "documentation":"The latest published version of the Q App used for the session.
" + }, "status":{ "shape":"ExecutionStatus", "documentation":"The current status of the Q App session.
" @@ -1755,6 +2224,10 @@ "cardStatus":{ "shape":"CardStatusMap", "documentation":"The current status for each card in the Q App session.
" + }, + "userIsHost":{ + "shape":"Boolean", + "documentation":"Indicates whether the current user is the owner of the Q App data collection session.
" } } }, @@ -1777,7 +2250,7 @@ }, "cardId":{ "shape":"UUID", - "documentation":"The unique identifier of the card the file is associated with, if applicable.
" + "documentation":"The unique identifier of the card the file is associated with.
" }, "appId":{ "shape":"UUID", @@ -1793,7 +2266,7 @@ }, "scope":{ "shape":"DocumentScope", - "documentation":"Whether the file is associated with an Q App definition or a specific Q App session.
" + "documentation":"Whether the file is associated with a Q App definition or a specific Q App session.
" }, "sessionId":{ "shape":"UUID", @@ -1815,6 +2288,13 @@ "max":10000, "min":0 }, + "InputCardComputeMode":{ + "type":"string", + "enum":[ + "append", + "replace" + ] + }, "InstanceId":{"type":"string"}, "Integer":{ "type":"integer", @@ -1981,6 +2461,52 @@ } } }, + "ListQAppSessionDataInput":{ + "type":"structure", + "required":[ + "instanceId", + "sessionId" + ], + "members":{ + "instanceId":{ + "shape":"InstanceId", + "documentation":"The unique identifier of the Amazon Q Business application environment instance.
", + "location":"header", + "locationName":"instance-id" + }, + "sessionId":{ + "shape":"UUID", + "documentation":"The unique identifier of the Q App data collection session.
", + "location":"querystring", + "locationName":"sessionId" + } + } + }, + "ListQAppSessionDataOutput":{ + "type":"structure", + "required":[ + "sessionId", + "sessionArn" + ], + "members":{ + "sessionId":{ + "shape":"UUID", + "documentation":"The unique identifier of the Q App data collection session.
" + }, + "sessionArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the Q App data collection session.
" + }, + "sessionData":{ + "shape":"QAppSessionDataList", + "documentation":"The collected responses of a Q App session.
" + }, + "nextToken":{ + "shape":"String", + "documentation":"The pagination token that indicates the next set of results to retrieve.
" + } + } + }, "ListQAppsInput":{ "type":"structure", "required":["instanceId"], @@ -2044,6 +2570,10 @@ "type":"long", "box":true }, + "MemoryReferenceList":{ + "type":"list", + "member":{"shape":"String"} + }, "PageLimit":{ "type":"integer", "box":true, @@ -2055,6 +2585,70 @@ "max":300, "min":0 }, + "PermissionInput":{ + "type":"structure", + "required":[ + "action", + "principal" + ], + "members":{ + "action":{ + "shape":"PermissionInputActionEnum", + "documentation":"The action associated with the permission.
" + }, + "principal":{ + "shape":"PermissionInputPrincipalString", + "documentation":"The principal user to which the permission applies.
" + } + }, + "documentation":"The permission to grant or revoke for a Amazon Q App.
" + }, + "PermissionInputActionEnum":{ + "type":"string", + "enum":[ + "read", + "write" + ], + "max":20, + "min":1 + }, + "PermissionInputPrincipalString":{ + "type":"string", + "max":256, + "min":1 + }, + "PermissionOutput":{ + "type":"structure", + "required":[ + "action", + "principal" + ], + "members":{ + "action":{ + "shape":"PermissionOutputActionEnum", + "documentation":"The action associated with the permission.
" + }, + "principal":{ + "shape":"PrincipalOutput", + "documentation":"The principal user to which the permission applies.
" + } + }, + "documentation":"The permission granted to the Amazon Q App.
" + }, + "PermissionOutputActionEnum":{ + "type":"string", + "enum":[ + "read", + "write" + ], + "max":20, + "min":1 + }, + "PermissionsOutputList":{ + "type":"list", + "member":{"shape":"PermissionOutput"}, + "documentation":"A list of permissions granted for a Amazon Q App.
" + }, "Placeholder":{ "type":"string", "max":500, @@ -2161,11 +2755,87 @@ } } }, + "PresignedUrlFields":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "PrincipalOutput":{ + "type":"structure", + "members":{ + "userId":{ + "shape":"PrincipalOutputUserIdString", + "documentation":"The unique identifier of the user.
" + }, + "userType":{ + "shape":"PrincipalOutputUserTypeEnum", + "documentation":"The type of the user.
" + }, + "email":{ + "shape":"PrincipalOutputEmailString", + "documentation":"The email address associated with the user.
" + } + }, + "documentation":"The principal for which the permission applies.
" + }, + "PrincipalOutputEmailString":{ + "type":"string", + "max":256, + "min":1 + }, + "PrincipalOutputUserIdString":{ + "type":"string", + "max":256, + "min":1 + }, + "PrincipalOutputUserTypeEnum":{ + "type":"string", + "enum":[ + "owner", + "user" + ], + "max":256, + "min":1 + }, "Prompt":{ "type":"string", - "max":7000, + "max":50000, "min":0 }, + "QAppSessionData":{ + "type":"structure", + "required":[ + "cardId", + "user" + ], + "members":{ + "cardId":{ + "shape":"UUID", + "documentation":"The card Id associated with the response submitted for a Q App session.
" + }, + "value":{ + "shape":"Document", + "documentation":"The response submitted for a Q App session.
" + }, + "user":{ + "shape":"User", + "documentation":"The user who submitted the response for a Q App session.
" + }, + "submissionId":{ + "shape":"UUID", + "documentation":"The unique identifier of the submission.
" + }, + "timestamp":{ + "shape":"QAppsTimestamp", + "documentation":"The date and time when the session data is submitted.
" + } + }, + "documentation":"The response collected for a Amazon Q App session. This container represents a single response to a Q App session.
" + }, + "QAppSessionDataList":{ + "type":"list", + "member":{"shape":"QAppSessionData"} + }, "QAppsTimestamp":{ "type":"timestamp", "timestampFormat":"iso8601" @@ -2284,6 +2954,10 @@ "attributeFilter":{ "shape":"AttributeFilter", "documentation":"The Amazon Q Business filters applied in this query card when resolving data sources
" + }, + "memoryReferences":{ + "shape":"MemoryReferenceList", + "documentation":"Any dependencies for the query card, where the dependencies are references to the collected responses.
" } }, "documentation":"A card in a Amazon Q App that generates a response based on the Amazon Q Business service.
" @@ -2391,6 +3065,42 @@ }, "exception":true }, + "SessionName":{ + "type":"string", + "max":100, + "min":0 + }, + "SessionSharingAcceptResponses":{ + "type":"boolean", + "box":true + }, + "SessionSharingConfiguration":{ + "type":"structure", + "required":["enabled"], + "members":{ + "enabled":{ + "shape":"SessionSharingEnabled", + "documentation":"Indicates whether an Q App session is shareable with other users.
" + }, + "acceptResponses":{ + "shape":"SessionSharingAcceptResponses", + "documentation":"Indicates whether an Q App session can accept responses from users.
" + }, + "revealCards":{ + "shape":"SessionSharingRevealCards", + "documentation":"Indicates whether collected responses for an Q App session are revealed for all users.
" + } + }, + "documentation":"The sharing configuration of an Amazon Q App data collection session.
" + }, + "SessionSharingEnabled":{ + "type":"boolean", + "box":true + }, + "SessionSharingRevealCards":{ + "type":"boolean", + "box":true + }, "StartQAppSessionInput":{ "type":"structure", "required":[ @@ -2417,6 +3127,10 @@ "shape":"CardValueList", "documentation":"Optional initial input values to provide for the Q App session.
" }, + "sessionId":{ + "shape":"String", + "documentation":"The unique identifier of the a Q App session.
" + }, "tags":{ "shape":"TagMap", "documentation":"Optional tags to associate with the new Q App session.
" @@ -2432,7 +3146,7 @@ "members":{ "sessionId":{ "shape":"String", - "documentation":"The unique identifier of the new Q App session.
" + "documentation":"The unique identifier of the new or retrieved Q App session.
" }, "sessionArn":{ "shape":"String", @@ -2460,6 +3174,54 @@ } }, "String":{"type":"string"}, + "Submission":{ + "type":"structure", + "members":{ + "value":{ + "shape":"Document", + "documentation":"The data submitted by the user.
" + }, + "submissionId":{ + "shape":"UUID", + "documentation":"The unique identifier of the submission.
" + }, + "timestamp":{ + "shape":"QAppsTimestamp", + "documentation":"The date and time when the card is submitted.
" + } + }, + "documentation":"A record created when a user submits a form card.
" + }, + "SubmissionList":{ + "type":"list", + "member":{"shape":"Submission"} + }, + "SubmissionMutation":{ + "type":"structure", + "required":[ + "submissionId", + "mutationType" + ], + "members":{ + "submissionId":{ + "shape":"UUID", + "documentation":"The unique identifier of the submission.
" + }, + "mutationType":{ + "shape":"SubmissionMutationKind", + "documentation":"The operation that is performed on a submission.
" + } + }, + "documentation":"Represents an action performed on a submission.
" + }, + "SubmissionMutationKind":{ + "type":"string", + "enum":[ + "edit", + "delete", + "add" + ] + }, "TagKey":{ "type":"string", "max":128, @@ -2871,6 +3633,64 @@ } } }, + "UpdateQAppPermissionsInput":{ + "type":"structure", + "required":[ + "instanceId", + "appId" + ], + "members":{ + "instanceId":{ + "shape":"InstanceId", + "documentation":"The unique identifier of the Amazon Q Business application environment instance.
", + "location":"header", + "locationName":"instance-id" + }, + "appId":{ + "shape":"UUID", + "documentation":"The unique identifier of the Amazon Q App for which permissions are being updated.
" + }, + "grantPermissions":{ + "shape":"UpdateQAppPermissionsInputGrantPermissionsList", + "documentation":"The list of permissions to grant for the Amazon Q App.
" + }, + "revokePermissions":{ + "shape":"UpdateQAppPermissionsInputRevokePermissionsList", + "documentation":"The list of permissions to revoke for the Amazon Q App.
" + } + } + }, + "UpdateQAppPermissionsInputGrantPermissionsList":{ + "type":"list", + "member":{"shape":"PermissionInput"}, + "documentation":"A list of permissions to grant or revoke for a Amazon Q App.
", + "max":100, + "min":0 + }, + "UpdateQAppPermissionsInputRevokePermissionsList":{ + "type":"list", + "member":{"shape":"PermissionInput"}, + "documentation":"A list of permissions to grant or revoke for a Amazon Q App.
", + "max":100, + "min":0 + }, + "UpdateQAppPermissionsOutput":{ + "type":"structure", + "members":{ + "resourceArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the Amazon Q App for which permissions were updated.
" + }, + "appId":{ + "shape":"String", + "documentation":"The unique identifier of the Amazon Q App for which permissions were updated.
" + }, + "permissions":{ + "shape":"PermissionsOutputList", + "documentation":"The updated list of permissions for the Amazon Q App.
" + } + } + }, "UpdateQAppSessionInput":{ "type":"structure", "required":[ @@ -2894,6 +3714,60 @@ } } }, + "UpdateQAppSessionMetadataInput":{ + "type":"structure", + "required":[ + "instanceId", + "sessionId", + "sharingConfiguration" + ], + "members":{ + "instanceId":{ + "shape":"InstanceId", + "documentation":"The unique identifier of the Amazon Q Business application environment instance.
", + "location":"header", + "locationName":"instance-id" + }, + "sessionId":{ + "shape":"UUID", + "documentation":"The unique identifier of the Q App session to update configuration for.
" + }, + "sessionName":{ + "shape":"SessionName", + "documentation":"The new name for the Q App session.
" + }, + "sharingConfiguration":{ + "shape":"SessionSharingConfiguration", + "documentation":"The new sharing configuration for the Q App data collection session.
" + } + } + }, + "UpdateQAppSessionMetadataOutput":{ + "type":"structure", + "required":[ + "sessionId", + "sessionArn", + "sharingConfiguration" + ], + "members":{ + "sessionId":{ + "shape":"UUID", + "documentation":"The unique identifier of the updated Q App session.
" + }, + "sessionArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the updated Q App session.
" + }, + "sessionName":{ + "shape":"SessionName", + "documentation":"The new name of the updated Q App session.
" + }, + "sharingConfiguration":{ + "shape":"SessionSharingConfiguration", + "documentation":"The new sharing configuration of the updated Q App data collection session.
" + } + } + }, "UpdateQAppSessionOutput":{ "type":"structure", "required":[ @@ -2911,6 +3785,16 @@ } } }, + "User":{ + "type":"structure", + "members":{ + "userId":{ + "shape":"UserId", + "documentation":"The unique identifier of a user.
" + } + }, + "documentation":"A user of an Amazon Q App.
" + }, "UserAppItem":{ "type":"structure", "required":[ @@ -2959,6 +3843,7 @@ "type":"list", "member":{"shape":"UserAppItem"} }, + "UserId":{"type":"string"}, "ValidationException":{ "type":"structure", "required":["message"], diff --git a/docs/source/conf.py b/docs/source/conf.py index 64d551b124..00be59498d 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -59,7 +59,7 @@ # The short X.Y version. version = '1.35.' # The full version, including alpha/beta/rc tags. -release = '1.35.69' +release = '1.35.70' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages.