aws-sdk 2.1615.0 → 2.1617.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/apis/bedrock-agent-runtime-2023-07-26.min.json +64 -2
- package/apis/cognito-idp-2016-04-18.min.json +3 -0
- package/apis/ec2-2016-11-15.min.json +282 -279
- package/apis/ecr-2015-09-21.min.json +3 -0
- package/apis/metadata.json +0 -6
- package/apis/pinpoint-2016-12-01.min.json +399 -377
- package/apis/sqs-2012-11-05.min.json +21 -14
- package/apis/ssm-sap-2018-05-10.min.json +95 -0
- package/apis/ssm-sap-2018-05-10.paginators.json +6 -0
- package/apis/verifiedpermissions-2021-12-01.min.json +52 -27
- package/clients/all.d.ts +0 -2
- package/clients/all.js +0 -2
- package/clients/bedrockagentruntime.d.ts +80 -8
- package/clients/cognitoidentityserviceprovider.d.ts +1 -1
- package/clients/ec2.d.ts +5 -0
- package/clients/ecr.d.ts +2 -2
- package/clients/fms.d.ts +4 -4
- package/clients/pinpoint.d.ts +27 -0
- package/clients/polly.d.ts +9 -9
- package/clients/route53resolver.d.ts +3 -3
- package/clients/sqs.d.ts +19 -14
- package/clients/ssmsap.d.ts +121 -1
- package/clients/verifiedpermissions.d.ts +40 -6
- package/dist/aws-sdk-core-react-native.js +2 -2
- package/dist/aws-sdk-react-native.js +1629 -1703
- package/dist/aws-sdk.js +312 -302
- package/dist/aws-sdk.min.js +64 -64
- package/lib/config_service_placeholders.d.ts +0 -4
- package/lib/core.js +1 -1
- package/package.json +1 -1
- package/apis/alexaforbusiness-2017-11-09.examples.json +0 -5
- package/apis/alexaforbusiness-2017-11-09.min.json +0 -2905
- package/apis/alexaforbusiness-2017-11-09.paginators.json +0 -94
- package/apis/honeycode-2020-03-01.examples.json +0 -5
- package/apis/honeycode-2020-03-01.min.json +0 -962
- package/apis/honeycode-2020-03-01.paginators.json +0 -27
- package/clients/alexaforbusiness.d.ts +0 -3862
- package/clients/alexaforbusiness.js +0 -18
- package/clients/honeycode.d.ts +0 -910
- package/clients/honeycode.js +0 -18
@@ -13,11 +13,11 @@ declare class BedrockAgentRuntime extends Service {
|
|
13
13
|
constructor(options?: BedrockAgentRuntime.Types.ClientConfiguration)
|
14
14
|
config: Config & BedrockAgentRuntime.Types.ClientConfiguration;
|
15
15
|
/**
|
16
|
-
* Sends a prompt for the agent to process and respond to.
|
16
|
+
* The CLI doesn't support InvokeAgent. Sends a prompt for the agent to process and respond to. Note the following fields for the request: To continue the same conversation with an agent, use the same sessionId value in the request. To activate trace enablement, turn enableTrace to true. Trace enablement helps you follow the agent's reasoning process that led it to the information it processed, the actions it took, and the final result it yielded. For more information, see Trace enablement. End a conversation by setting endSession to true. In the sessionState object, you can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group. The response is returned in the bytes field of the chunk object. The attribution object contains citations for parts of the response. If you set enableTrace to true in the request, you can trace the agent's steps and reasoning process that led it to the response. If the action predicted was configured to return control, the response returns parameters for the action, elicited from the user, in the returnControl field. Errors are also surfaced in the response.
|
17
17
|
*/
|
18
18
|
invokeAgent(params: BedrockAgentRuntime.Types.InvokeAgentRequest, callback?: (err: AWSError, data: BedrockAgentRuntime.Types.InvokeAgentResponse) => void): Request<BedrockAgentRuntime.Types.InvokeAgentResponse, AWSError>;
|
19
19
|
/**
|
20
|
-
* Sends a prompt for the agent to process and respond to.
|
20
|
+
* The CLI doesn't support InvokeAgent. Sends a prompt for the agent to process and respond to. Note the following fields for the request: To continue the same conversation with an agent, use the same sessionId value in the request. To activate trace enablement, turn enableTrace to true. Trace enablement helps you follow the agent's reasoning process that led it to the information it processed, the actions it took, and the final result it yielded. For more information, see Trace enablement. End a conversation by setting endSession to true. In the sessionState object, you can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group. The response is returned in the bytes field of the chunk object. The attribution object contains citations for parts of the response. If you set enableTrace to true in the request, you can trace the agent's steps and reasoning process that led it to the response. If the action predicted was configured to return control, the response returns parameters for the action, elicited from the user, in the returnControl field. Errors are also surfaced in the response.
|
21
21
|
*/
|
22
22
|
invokeAgent(callback?: (err: AWSError, data: BedrockAgentRuntime.Types.InvokeAgentResponse) => void): Request<BedrockAgentRuntime.Types.InvokeAgentResponse, AWSError>;
|
23
23
|
/**
|
@@ -75,6 +75,10 @@ declare namespace BedrockAgentRuntime {
|
|
75
75
|
}
|
76
76
|
export type ActionGroupName = string;
|
77
77
|
export type ActionGroupOutputString = string;
|
78
|
+
export type AdditionalModelRequestFields = {[key: string]: AdditionalModelRequestFieldsValue};
|
79
|
+
export type AdditionalModelRequestFieldsKey = string;
|
80
|
+
export interface AdditionalModelRequestFieldsValue {
|
81
|
+
}
|
78
82
|
export type AgentAliasId = string;
|
79
83
|
export type AgentId = string;
|
80
84
|
export type AgentVersion = string;
|
@@ -141,7 +145,7 @@ declare namespace BedrockAgentRuntime {
|
|
141
145
|
*/
|
142
146
|
httpStatusCode?: Integer;
|
143
147
|
/**
|
144
|
-
* The response body from the API operation. The key of the object is the content type. The response may be returned directly or from the Lambda function.
|
148
|
+
* The response body from the API operation. The key of the object is the content type (currently, only TEXT is supported). The response may be returned directly or from the Lambda function.
|
145
149
|
*/
|
146
150
|
responseBody?: ResponseBody;
|
147
151
|
/**
|
@@ -227,6 +231,18 @@ declare namespace BedrockAgentRuntime {
|
|
227
231
|
export type ExternalSourceType = "S3"|"BYTE_CONTENT"|string;
|
228
232
|
export type ExternalSources = ExternalSource[];
|
229
233
|
export interface ExternalSourcesGenerationConfiguration {
|
234
|
+
/**
|
235
|
+
* Additional model parameters and their corresponding values not included in the textInferenceConfig structure for an external source. Takes in custom model parameters specific to the language model being used.
|
236
|
+
*/
|
237
|
+
additionalModelRequestFields?: AdditionalModelRequestFields;
|
238
|
+
/**
|
239
|
+
* The configuration details for the guardrail.
|
240
|
+
*/
|
241
|
+
guardrailConfiguration?: GuardrailConfiguration;
|
242
|
+
/**
|
243
|
+
* Configuration settings for inference when using RetrieveAndGenerate to generate responses while using an external source.
|
244
|
+
*/
|
245
|
+
inferenceConfig?: InferenceConfig;
|
230
246
|
/**
|
231
247
|
* Contain the textPromptTemplate string for the external source wrapper object.
|
232
248
|
*/
|
@@ -317,7 +333,7 @@ declare namespace BedrockAgentRuntime {
|
|
317
333
|
*/
|
318
334
|
function?: String;
|
319
335
|
/**
|
320
|
-
* The response from the function call using the parameters. The response may be returned directly or from the Lambda function.
|
336
|
+
* The response from the function call using the parameters. The key of the object is the content type (currently, only TEXT is supported). The response may be returned directly or from the Lambda function.
|
321
337
|
*/
|
322
338
|
responseBody?: ResponseBody;
|
323
339
|
/**
|
@@ -332,12 +348,43 @@ declare namespace BedrockAgentRuntime {
|
|
332
348
|
textResponsePart?: TextResponsePart;
|
333
349
|
}
|
334
350
|
export interface GenerationConfiguration {
|
351
|
+
/**
|
352
|
+
* Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows users to provide custom model parameters specific to the language model being used.
|
353
|
+
*/
|
354
|
+
additionalModelRequestFields?: AdditionalModelRequestFields;
|
355
|
+
/**
|
356
|
+
* The configuration details for the guardrail.
|
357
|
+
*/
|
358
|
+
guardrailConfiguration?: GuardrailConfiguration;
|
359
|
+
/**
|
360
|
+
* Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source.
|
361
|
+
*/
|
362
|
+
inferenceConfig?: InferenceConfig;
|
335
363
|
/**
|
336
364
|
* Contains the template for the prompt that's sent to the model for response generation.
|
337
365
|
*/
|
338
366
|
promptTemplate?: PromptTemplate;
|
339
367
|
}
|
368
|
+
export type GuadrailAction = "INTERVENED"|"NONE"|string;
|
369
|
+
export interface GuardrailConfiguration {
|
370
|
+
/**
|
371
|
+
* The unique identifier for the guardrail.
|
372
|
+
*/
|
373
|
+
guardrailId: GuardrailConfigurationGuardrailIdString;
|
374
|
+
/**
|
375
|
+
* The version of the guardrail.
|
376
|
+
*/
|
377
|
+
guardrailVersion: GuardrailConfigurationGuardrailVersionString;
|
378
|
+
}
|
379
|
+
export type GuardrailConfigurationGuardrailIdString = string;
|
380
|
+
export type GuardrailConfigurationGuardrailVersionString = string;
|
340
381
|
export type Identifier = string;
|
382
|
+
export interface InferenceConfig {
|
383
|
+
/**
|
384
|
+
* Configuration settings specific to text generation while generating responses using RetrieveAndGenerate.
|
385
|
+
*/
|
386
|
+
textInferenceConfig?: TextInferenceConfig;
|
387
|
+
}
|
341
388
|
export interface InferenceConfiguration {
|
342
389
|
/**
|
343
390
|
* The maximum number of tokens allowed in the generated response.
|
@@ -423,7 +470,7 @@ declare namespace BedrockAgentRuntime {
|
|
423
470
|
*/
|
424
471
|
endSession?: Boolean;
|
425
472
|
/**
|
426
|
-
* The prompt text to send the agent.
|
473
|
+
* The prompt text to send the agent. If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.
|
427
474
|
*/
|
428
475
|
inputText?: InputText;
|
429
476
|
/**
|
@@ -431,7 +478,7 @@ declare namespace BedrockAgentRuntime {
|
|
431
478
|
*/
|
432
479
|
sessionId: SessionId;
|
433
480
|
/**
|
434
|
-
* Contains parameters that specify various attributes of the session. For more information, see Control session context.
|
481
|
+
* 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.
|
435
482
|
*/
|
436
483
|
sessionState?: SessionState;
|
437
484
|
}
|
@@ -534,6 +581,7 @@ declare namespace BedrockAgentRuntime {
|
|
534
581
|
}
|
535
582
|
export type KnowledgeBaseVectorSearchConfigurationNumberOfResultsInteger = number;
|
536
583
|
export type LambdaArn = string;
|
584
|
+
export type MaxTokens = number;
|
537
585
|
export type MaximumLength = number;
|
538
586
|
export type MimeType = string;
|
539
587
|
export interface ModelInvocationInput {
|
@@ -711,6 +759,8 @@ declare namespace BedrockAgentRuntime {
|
|
711
759
|
*/
|
712
760
|
properties?: ParameterList;
|
713
761
|
}
|
762
|
+
export type RAGStopSequences = RAGStopSequencesMemberString[];
|
763
|
+
export type RAGStopSequencesMemberString = string;
|
714
764
|
export interface Rationale {
|
715
765
|
/**
|
716
766
|
* The reasoning or thought process of the agent, based on the input.
|
@@ -868,6 +918,10 @@ declare namespace BedrockAgentRuntime {
|
|
868
918
|
* A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.
|
869
919
|
*/
|
870
920
|
citations?: Citations;
|
921
|
+
/**
|
922
|
+
* Specifies if there is a guardrail intervention in the response.
|
923
|
+
*/
|
924
|
+
guardrailAction?: GuadrailAction;
|
871
925
|
/**
|
872
926
|
* Contains the response generated from querying the knowledge base.
|
873
927
|
*/
|
@@ -953,7 +1007,7 @@ declare namespace BedrockAgentRuntime {
|
|
953
1007
|
export type SessionId = string;
|
954
1008
|
export interface SessionState {
|
955
1009
|
/**
|
956
|
-
* The identifier of the invocation.
|
1010
|
+
* The identifier of the invocation of an action. This value must match the invocationId returned in the InvokeAgent response for the action whose results are provided in the returnControlInvocationResults field. For more information, see Return control to the agent developer and Control session context.
|
957
1011
|
*/
|
958
1012
|
invocationId?: String;
|
959
1013
|
/**
|
@@ -961,7 +1015,7 @@ declare namespace BedrockAgentRuntime {
|
|
961
1015
|
*/
|
962
1016
|
promptSessionAttributes?: PromptSessionAttributesMap;
|
963
1017
|
/**
|
964
|
-
* Contains information about the results from the action group invocation.
|
1018
|
+
* Contains information about the results from the action group invocation. For more information, see Return control to the agent developer and Control session context. If you include this field, the inputText field will be ignored.
|
965
1019
|
*/
|
966
1020
|
returnControlInvocationResults?: ReturnControlInvocationResults;
|
967
1021
|
/**
|
@@ -985,6 +1039,24 @@ declare namespace BedrockAgentRuntime {
|
|
985
1039
|
export type StopSequences = String[];
|
986
1040
|
export type String = string;
|
987
1041
|
export type Temperature = number;
|
1042
|
+
export interface TextInferenceConfig {
|
1043
|
+
/**
|
1044
|
+
* The maximum number of tokens to generate in the output text. Do not use the minimum of 0 or the maximum of 65536. The limit values described here are arbitary values, for actual values consult the limits defined by your specific model.
|
1045
|
+
*/
|
1046
|
+
maxTokens?: MaxTokens;
|
1047
|
+
/**
|
1048
|
+
* A list of sequences of characters that, if generated, will cause the model to stop generating further tokens. Do not use a minimum length of 1 or a maximum length of 1000. The limit values described here are arbitary values, for actual values consult the limits defined by your specific model.
|
1049
|
+
*/
|
1050
|
+
stopSequences?: RAGStopSequences;
|
1051
|
+
/**
|
1052
|
+
* Controls the random-ness of text generated by the language model, influencing how much the model sticks to the most predictable next words versus exploring more surprising options. A lower temperature value (e.g. 0.2 or 0.3) makes model outputs more deterministic or predictable, while a higher temperature (e.g. 0.8 or 0.9) makes the outputs more creative or unpredictable.
|
1053
|
+
*/
|
1054
|
+
temperature?: Temperature;
|
1055
|
+
/**
|
1056
|
+
* A probability distribution threshold which controls what the model considers for the set of possible next tokens. The model will only consider the top p% of the probability distribution when generating the next token.
|
1057
|
+
*/
|
1058
|
+
topP?: TopP;
|
1059
|
+
}
|
988
1060
|
export type TextPromptTemplate = string;
|
989
1061
|
export interface TextResponsePart {
|
990
1062
|
/**
|
@@ -4658,7 +4658,7 @@ declare namespace CognitoIdentityServiceProvider {
|
|
4658
4658
|
*/
|
4659
4659
|
AccountRecoverySetting?: AccountRecoverySettingType;
|
4660
4660
|
}
|
4661
|
-
export type UserStatusType = "UNCONFIRMED"|"CONFIRMED"|"ARCHIVED"|"COMPROMISED"|"UNKNOWN"|"RESET_REQUIRED"|"FORCE_CHANGE_PASSWORD"|string;
|
4661
|
+
export type UserStatusType = "UNCONFIRMED"|"CONFIRMED"|"ARCHIVED"|"COMPROMISED"|"UNKNOWN"|"RESET_REQUIRED"|"FORCE_CHANGE_PASSWORD"|"EXTERNAL_PROVIDER"|string;
|
4662
4662
|
export interface UserType {
|
4663
4663
|
/**
|
4664
4664
|
* The user name of the user you want to describe.
|
package/clients/ec2.d.ts
CHANGED
@@ -25456,6 +25456,10 @@ declare namespace EC2 {
|
|
25456
25456
|
* Describes the Neuron accelerator settings for the instance type.
|
25457
25457
|
*/
|
25458
25458
|
NeuronInfo?: NeuronInfo;
|
25459
|
+
/**
|
25460
|
+
* Indicates whether a local Precision Time Protocol (PTP) hardware clock (PHC) is supported.
|
25461
|
+
*/
|
25462
|
+
PhcSupport?: PhcSupport;
|
25459
25463
|
}
|
25460
25464
|
export interface InstanceTypeInfoFromInstanceRequirements {
|
25461
25465
|
/**
|
@@ -31746,6 +31750,7 @@ declare namespace EC2 {
|
|
31746
31750
|
*/
|
31747
31751
|
Value?: String;
|
31748
31752
|
}
|
31753
|
+
export type PhcSupport = "unsupported"|"supported"|string;
|
31749
31754
|
export interface Placement {
|
31750
31755
|
/**
|
31751
31756
|
* The Availability Zone of the instance. If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region. This parameter is not supported for CreateFleet.
|
package/clients/ecr.d.ts
CHANGED
@@ -577,7 +577,7 @@ declare namespace ECR {
|
|
577
577
|
*/
|
578
578
|
ecrRepositoryPrefix: PullThroughCacheRuleRepositoryPrefix;
|
579
579
|
/**
|
580
|
-
* The registry URL of the upstream public registry to use as the source for the pull through cache rule. The following is the syntax to use for each supported upstream registry. Amazon ECR Public (ecr-public) - public.ecr.aws Docker Hub (docker-hub) - registry-1.docker.io Quay (quay) - quay.io Kubernetes (k8s) - registry.k8s.io GitHub Container Registry (github-container-registry) - ghcr.io Microsoft Azure Container Registry (azure-container-registry) - <custom>.azurecr.io
|
580
|
+
* The registry URL of the upstream public registry to use as the source for the pull through cache rule. The following is the syntax to use for each supported upstream registry. Amazon ECR Public (ecr-public) - public.ecr.aws Docker Hub (docker-hub) - registry-1.docker.io Quay (quay) - quay.io Kubernetes (k8s) - registry.k8s.io GitHub Container Registry (github-container-registry) - ghcr.io Microsoft Azure Container Registry (azure-container-registry) - <custom>.azurecr.io GitLab Container Registry (gitlab-container-registry) - registry.gitlab.com
|
581
581
|
*/
|
582
582
|
upstreamRegistryUrl: Url;
|
583
583
|
/**
|
@@ -2288,7 +2288,7 @@ declare namespace ECR {
|
|
2288
2288
|
*/
|
2289
2289
|
lastByteReceived?: PartSize;
|
2290
2290
|
}
|
2291
|
-
export type UpstreamRegistry = "ecr-public"|"quay"|"k8s"|"docker-hub"|"github-container-registry"|"azure-container-registry"|string;
|
2291
|
+
export type UpstreamRegistry = "ecr-public"|"quay"|"k8s"|"docker-hub"|"github-container-registry"|"azure-container-registry"|"gitlab-container-registry"|string;
|
2292
2292
|
export type Url = string;
|
2293
2293
|
export interface ValidatePullThroughCacheRuleRequest {
|
2294
2294
|
/**
|
package/clients/fms.d.ts
CHANGED
@@ -1607,7 +1607,7 @@ declare namespace FMS {
|
|
1607
1607
|
*/
|
1608
1608
|
FirstEntries?: NetworkAclEntries;
|
1609
1609
|
/**
|
1610
|
-
* Applies only when remediation is enabled for the policy as a whole. Firewall Manager uses this setting when it finds policy violations that involve conflicts between the custom entries and the policy entries. If forced remediation is disabled, Firewall Manager marks the network ACL as noncompliant and does not try to remediate. For more information about the remediation behavior, see
|
1610
|
+
* Applies only when remediation is enabled for the policy as a whole. Firewall Manager uses this setting when it finds policy violations that involve conflicts between the custom entries and the policy entries. If forced remediation is disabled, Firewall Manager marks the network ACL as noncompliant and does not try to remediate. For more information about the remediation behavior, see Remediation for managed network ACLs in the Firewall Manager Developer Guide.
|
1611
1611
|
*/
|
1612
1612
|
ForceRemediateForFirstEntries: BooleanObject;
|
1613
1613
|
/**
|
@@ -1615,7 +1615,7 @@ declare namespace FMS {
|
|
1615
1615
|
*/
|
1616
1616
|
LastEntries?: NetworkAclEntries;
|
1617
1617
|
/**
|
1618
|
-
* Applies only when remediation is enabled for the policy as a whole. Firewall Manager uses this setting when it finds policy violations that involve conflicts between the custom entries and the policy entries. If forced remediation is disabled, Firewall Manager marks the network ACL as noncompliant and does not try to remediate. For more information about the remediation behavior, see
|
1618
|
+
* Applies only when remediation is enabled for the policy as a whole. Firewall Manager uses this setting when it finds policy violations that involve conflicts between the custom entries and the policy entries. If forced remediation is disabled, Firewall Manager marks the network ACL as noncompliant and does not try to remediate. For more information about the remediation behavior, see Remediation for managed network ACLs in the Firewall Manager Developer Guide.
|
1619
1619
|
*/
|
1620
1620
|
ForceRemediateForLastEntries: BooleanObject;
|
1621
1621
|
}
|
@@ -2043,7 +2043,7 @@ declare namespace FMS {
|
|
2043
2043
|
*/
|
2044
2044
|
ResourceSetIds?: ResourceSetIds;
|
2045
2045
|
/**
|
2046
|
-
*
|
2046
|
+
* Your description of the Firewall Manager policy.
|
2047
2047
|
*/
|
2048
2048
|
PolicyDescription?: ResourceDescription;
|
2049
2049
|
/**
|
@@ -2525,7 +2525,7 @@ declare namespace FMS {
|
|
2525
2525
|
*/
|
2526
2526
|
Key: ResourceTagKey;
|
2527
2527
|
/**
|
2528
|
-
* The resource tag value.
|
2528
|
+
* The resource tag value. To specify an empty string value, either don't provide this or specify it as "".
|
2529
2529
|
*/
|
2530
2530
|
Value?: ResourceTagValue;
|
2531
2531
|
}
|
package/clients/pinpoint.d.ts
CHANGED
@@ -2024,6 +2024,10 @@ declare namespace Pinpoint {
|
|
2024
2024
|
* The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
|
2025
2025
|
*/
|
2026
2026
|
FromAddress?: __string;
|
2027
|
+
/**
|
2028
|
+
* The list of MessageHeaders for the email. You can have up to 15 MessageHeaders for each email.
|
2029
|
+
*/
|
2030
|
+
Headers?: ListOfMessageHeader;
|
2027
2031
|
/**
|
2028
2032
|
* The body of the email, in HTML format, for recipients whose email clients render HTML content.
|
2029
2033
|
*/
|
@@ -3064,6 +3068,10 @@ declare namespace Pinpoint {
|
|
3064
3068
|
* The subject line, or title, to use in email messages that are based on the message template.
|
3065
3069
|
*/
|
3066
3070
|
Subject?: __string;
|
3071
|
+
/**
|
3072
|
+
* The list of MessageHeaders for the email. You can have up to 15 Headers.
|
3073
|
+
*/
|
3074
|
+
Headers?: ListOfMessageHeader;
|
3067
3075
|
/**
|
3068
3076
|
* As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK. (Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
|
3069
3077
|
*/
|
@@ -3106,6 +3114,10 @@ declare namespace Pinpoint {
|
|
3106
3114
|
* The subject line, or title, that's used in email messages that are based on the message template.
|
3107
3115
|
*/
|
3108
3116
|
Subject?: __string;
|
3117
|
+
/**
|
3118
|
+
* The list of MessageHeaders for the email. You can have up to 15 Headers.
|
3119
|
+
*/
|
3120
|
+
Headers?: ListOfMessageHeader;
|
3109
3121
|
/**
|
3110
3122
|
* A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.
|
3111
3123
|
*/
|
@@ -6595,6 +6607,21 @@ declare namespace Pinpoint {
|
|
6595
6607
|
* The body of the email message, in plain text format. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.
|
6596
6608
|
*/
|
6597
6609
|
TextPart?: SimpleEmailPart;
|
6610
|
+
/**
|
6611
|
+
* The list of MessageHeaders for the email. You can have up to 15 Headers.
|
6612
|
+
*/
|
6613
|
+
Headers?: ListOfMessageHeader;
|
6614
|
+
}
|
6615
|
+
export type ListOfMessageHeader = MessageHeader[];
|
6616
|
+
export interface MessageHeader {
|
6617
|
+
/**
|
6618
|
+
* The name of the message header. The header name can contain up to 126 characters.
|
6619
|
+
*/
|
6620
|
+
Name?: __string;
|
6621
|
+
/**
|
6622
|
+
* The value of the message header. The header value can contain up to 870 characters, including the length of any rendered attributes. For example if you add the {CreationDate} attribute, it renders as YYYY-MM-DDTHH:MM:SS.SSSZ and is 24 characters in length.
|
6623
|
+
*/
|
6624
|
+
Value?: __string;
|
6598
6625
|
}
|
6599
6626
|
export interface SimpleEmailPart {
|
6600
6627
|
/**
|
package/clients/polly.d.ts
CHANGED
@@ -104,7 +104,7 @@ declare namespace Polly {
|
|
104
104
|
}
|
105
105
|
export interface DescribeVoicesInput {
|
106
106
|
/**
|
107
|
-
* Specifies the engine (standard, neural
|
107
|
+
* Specifies the engine (standard, neural, long-form or generative) used by Amazon Polly when processing input text for speech synthesis.
|
108
108
|
*/
|
109
109
|
Engine?: Engine;
|
110
110
|
/**
|
@@ -130,7 +130,7 @@ declare namespace Polly {
|
|
130
130
|
*/
|
131
131
|
NextToken?: NextToken;
|
132
132
|
}
|
133
|
-
export type Engine = "standard"|"neural"|"long-form"|string;
|
133
|
+
export type Engine = "standard"|"neural"|"long-form"|"generative"|string;
|
134
134
|
export type EngineList = Engine[];
|
135
135
|
export type Gender = "Female"|"Male"|string;
|
136
136
|
export interface GetLexiconInput {
|
@@ -284,7 +284,7 @@ declare namespace Polly {
|
|
284
284
|
export type SpeechMarkTypeList = SpeechMarkType[];
|
285
285
|
export interface StartSpeechSynthesisTaskInput {
|
286
286
|
/**
|
287
|
-
* Specifies the engine (standard, neural
|
287
|
+
* Specifies the engine (standard, neural, long-form or generative) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.
|
288
288
|
*/
|
289
289
|
Engine?: Engine;
|
290
290
|
/**
|
@@ -308,7 +308,7 @@ declare namespace Polly {
|
|
308
308
|
*/
|
309
309
|
OutputS3KeyPrefix?: OutputS3KeyPrefix;
|
310
310
|
/**
|
311
|
-
* The audio frequency specified in Hz. The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000". The default value for long-form voices is "24000". Valid values for pcm are "8000" and "16000" The default value is "16000".
|
311
|
+
* The audio frequency specified in Hz. The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000". The default value for long-form voices is "24000". The default value for generative voices is "24000". Valid values for pcm are "8000" and "16000" The default value is "16000".
|
312
312
|
*/
|
313
313
|
SampleRate?: SampleRate;
|
314
314
|
/**
|
@@ -340,7 +340,7 @@ declare namespace Polly {
|
|
340
340
|
}
|
341
341
|
export interface SynthesisTask {
|
342
342
|
/**
|
343
|
-
* Specifies the engine (standard, neural
|
343
|
+
* Specifies the engine (standard, neural, long-form or generative) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.
|
344
344
|
*/
|
345
345
|
Engine?: Engine;
|
346
346
|
/**
|
@@ -380,7 +380,7 @@ declare namespace Polly {
|
|
380
380
|
*/
|
381
381
|
OutputFormat?: OutputFormat;
|
382
382
|
/**
|
383
|
-
* The audio frequency specified in Hz. The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000". The default value for long-form voices is "24000". Valid values for pcm are "8000" and "16000" The default value is "16000".
|
383
|
+
* The audio frequency specified in Hz. The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000". The default value for long-form voices is "24000". The default value for generative voices is "24000". Valid values for pcm are "8000" and "16000" The default value is "16000".
|
384
384
|
*/
|
385
385
|
SampleRate?: SampleRate;
|
386
386
|
/**
|
@@ -403,7 +403,7 @@ declare namespace Polly {
|
|
403
403
|
export type SynthesisTasks = SynthesisTask[];
|
404
404
|
export interface SynthesizeSpeechInput {
|
405
405
|
/**
|
406
|
-
* Specifies the engine (standard, neural
|
406
|
+
* Specifies the engine (standard, neural, long-form, or generative) for Amazon Polly to use when processing input text for speech synthesis. Provide an engine that is supported by the voice you select. If you don't provide an engine, the standard engine is selected by default. If a chosen voice isn't supported by the standard engine, this will result in an error. For information on Amazon Polly voices and which voices are available for each engine, see Available Voices. Type: String Valid Values: standard | neural | long-form | generative Required: Yes
|
407
407
|
*/
|
408
408
|
Engine?: Engine;
|
409
409
|
/**
|
@@ -419,7 +419,7 @@ declare namespace Polly {
|
|
419
419
|
*/
|
420
420
|
OutputFormat: OutputFormat;
|
421
421
|
/**
|
422
|
-
* The audio frequency specified in Hz. The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000". The default value for long-form voices is "24000". Valid values for pcm are "8000" and "16000" The default value is "16000".
|
422
|
+
* The audio frequency specified in Hz. The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000". The default value for long-form voices is "24000". The default value for generative voices is "24000". Valid values for pcm are "8000" and "16000" The default value is "16000".
|
423
423
|
*/
|
424
424
|
SampleRate?: SampleRate;
|
425
425
|
/**
|
@@ -484,7 +484,7 @@ declare namespace Polly {
|
|
484
484
|
*/
|
485
485
|
AdditionalLanguageCodes?: LanguageCodeList;
|
486
486
|
/**
|
487
|
-
* Specifies which engines (standard, neural
|
487
|
+
* Specifies which engines (standard, neural, long-form or generative) are supported by a given voice.
|
488
488
|
*/
|
489
489
|
SupportedEngines?: EngineList;
|
490
490
|
}
|
@@ -737,7 +737,7 @@ declare namespace Route53Resolver {
|
|
737
737
|
*/
|
738
738
|
Name: Name;
|
739
739
|
/**
|
740
|
-
* How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME
|
740
|
+
* How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME or DNAME. Inspect_Redirection_Domain (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the domain list. Trust_Redirection_Domain inspects only the first domain in the redirection chain. You don't need to add the subsequent domains in the domain in the redirection list to the domain list.
|
741
741
|
*/
|
742
742
|
FirewallDomainRedirectionAction?: FirewallDomainRedirectionAction;
|
743
743
|
/**
|
@@ -1202,7 +1202,7 @@ declare namespace Route53Resolver {
|
|
1202
1202
|
*/
|
1203
1203
|
ModificationTime?: Rfc3339TimeString;
|
1204
1204
|
/**
|
1205
|
-
* How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME
|
1205
|
+
* How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME or DNAME. Inspect_Redirection_Domain (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the domain list. Trust_Redirection_Domain inspects only the first domain in the redirection chain. You don't need to add the subsequent domains in the domain in the redirection list to the domain list.
|
1206
1206
|
*/
|
1207
1207
|
FirewallDomainRedirectionAction?: FirewallDomainRedirectionAction;
|
1208
1208
|
/**
|
@@ -2646,7 +2646,7 @@ declare namespace Route53Resolver {
|
|
2646
2646
|
*/
|
2647
2647
|
Name?: Name;
|
2648
2648
|
/**
|
2649
|
-
* How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME
|
2649
|
+
* How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME or DNAME. Inspect_Redirection_Domain (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the domain list. Trust_Redirection_Domain inspects only the first domain in the redirection chain. You don't need to add the subsequent domains in the domain in the redirection list to the domain list.
|
2650
2650
|
*/
|
2651
2651
|
FirewallDomainRedirectionAction?: FirewallDomainRedirectionAction;
|
2652
2652
|
/**
|
package/clients/sqs.d.ts
CHANGED
@@ -20,11 +20,11 @@ declare class SQS extends Service {
|
|
20
20
|
*/
|
21
21
|
addPermission(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
22
22
|
/**
|
23
|
-
* Cancels a specified message movement task. A message movement can only be cancelled when the current status is RUNNING. Cancelling a message movement task does not revert the messages that have already been moved. It can only stop the messages that have not been moved yet. This action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source queue is the dead-letter queue (DLQ), while the destination queue can be the original source queue (from which the messages were driven to the dead-letter-queue), or a custom destination queue.
|
23
|
+
* Cancels a specified message movement task. A message movement can only be cancelled when the current status is RUNNING. Cancelling a message movement task does not revert the messages that have already been moved. It can only stop the messages that have not been moved yet. This action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source queue is the dead-letter queue (DLQ), while the destination queue can be the original source queue (from which the messages were driven to the dead-letter-queue), or a custom destination queue. Only one active message movement task is supported per queue at any given time.
|
24
24
|
*/
|
25
25
|
cancelMessageMoveTask(params: SQS.Types.CancelMessageMoveTaskRequest, callback?: (err: AWSError, data: SQS.Types.CancelMessageMoveTaskResult) => void): Request<SQS.Types.CancelMessageMoveTaskResult, AWSError>;
|
26
26
|
/**
|
27
|
-
* Cancels a specified message movement task. A message movement can only be cancelled when the current status is RUNNING. Cancelling a message movement task does not revert the messages that have already been moved. It can only stop the messages that have not been moved yet. This action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source queue is the dead-letter queue (DLQ), while the destination queue can be the original source queue (from which the messages were driven to the dead-letter-queue), or a custom destination queue.
|
27
|
+
* Cancels a specified message movement task. A message movement can only be cancelled when the current status is RUNNING. Cancelling a message movement task does not revert the messages that have already been moved. It can only stop the messages that have not been moved yet. This action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source queue is the dead-letter queue (DLQ), while the destination queue can be the original source queue (from which the messages were driven to the dead-letter-queue), or a custom destination queue. Only one active message movement task is supported per queue at any given time.
|
28
28
|
*/
|
29
29
|
cancelMessageMoveTask(callback?: (err: AWSError, data: SQS.Types.CancelMessageMoveTaskResult) => void): Request<SQS.Types.CancelMessageMoveTaskResult, AWSError>;
|
30
30
|
/**
|
@@ -100,11 +100,11 @@ declare class SQS extends Service {
|
|
100
100
|
*/
|
101
101
|
listDeadLetterSourceQueues(callback?: (err: AWSError, data: SQS.Types.ListDeadLetterSourceQueuesResult) => void): Request<SQS.Types.ListDeadLetterSourceQueuesResult, AWSError>;
|
102
102
|
/**
|
103
|
-
* Gets the most recent message movement tasks (up to 10) under a specific source queue. This action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source queue is the dead-letter queue (DLQ), while the destination queue can be the original source queue (from which the messages were driven to the dead-letter-queue), or a custom destination queue.
|
103
|
+
* Gets the most recent message movement tasks (up to 10) under a specific source queue. This action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source queue is the dead-letter queue (DLQ), while the destination queue can be the original source queue (from which the messages were driven to the dead-letter-queue), or a custom destination queue. Only one active message movement task is supported per queue at any given time.
|
104
104
|
*/
|
105
105
|
listMessageMoveTasks(params: SQS.Types.ListMessageMoveTasksRequest, callback?: (err: AWSError, data: SQS.Types.ListMessageMoveTasksResult) => void): Request<SQS.Types.ListMessageMoveTasksResult, AWSError>;
|
106
106
|
/**
|
107
|
-
* Gets the most recent message movement tasks (up to 10) under a specific source queue. This action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source queue is the dead-letter queue (DLQ), while the destination queue can be the original source queue (from which the messages were driven to the dead-letter-queue), or a custom destination queue.
|
107
|
+
* Gets the most recent message movement tasks (up to 10) under a specific source queue. This action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source queue is the dead-letter queue (DLQ), while the destination queue can be the original source queue (from which the messages were driven to the dead-letter-queue), or a custom destination queue. Only one active message movement task is supported per queue at any given time.
|
108
108
|
*/
|
109
109
|
listMessageMoveTasks(callback?: (err: AWSError, data: SQS.Types.ListMessageMoveTasksResult) => void): Request<SQS.Types.ListMessageMoveTasksResult, AWSError>;
|
110
110
|
/**
|
@@ -164,19 +164,19 @@ declare class SQS extends Service {
|
|
164
164
|
*/
|
165
165
|
sendMessageBatch(callback?: (err: AWSError, data: SQS.Types.SendMessageBatchResult) => void): Request<SQS.Types.SendMessageBatchResult, AWSError>;
|
166
166
|
/**
|
167
|
-
* Sets the value of one or more queue attributes. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the Amazon SQS system. Changes made to the MessageRetentionPeriod attribute can take up to 15 minutes and will impact existing messages in the queue potentially causing them to be expired and deleted if the MessageRetentionPeriod is reduced below the age of existing messages. In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully. Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide. To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.
|
167
|
+
* Sets the value of one or more queue attributes, like a policy. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the Amazon SQS system. Changes made to the MessageRetentionPeriod attribute can take up to 15 minutes and will impact existing messages in the queue potentially causing them to be expired and deleted if the MessageRetentionPeriod is reduced below the age of existing messages. In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully. Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide. To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.
|
168
168
|
*/
|
169
169
|
setQueueAttributes(params: SQS.Types.SetQueueAttributesRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
170
170
|
/**
|
171
|
-
* Sets the value of one or more queue attributes. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the Amazon SQS system. Changes made to the MessageRetentionPeriod attribute can take up to 15 minutes and will impact existing messages in the queue potentially causing them to be expired and deleted if the MessageRetentionPeriod is reduced below the age of existing messages. In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully. Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide. To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.
|
171
|
+
* Sets the value of one or more queue attributes, like a policy. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the Amazon SQS system. Changes made to the MessageRetentionPeriod attribute can take up to 15 minutes and will impact existing messages in the queue potentially causing them to be expired and deleted if the MessageRetentionPeriod is reduced below the age of existing messages. In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully. Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide. To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.
|
172
172
|
*/
|
173
173
|
setQueueAttributes(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
174
174
|
/**
|
175
|
-
* Starts an asynchronous task to move messages from a specified source queue to a specified destination queue. This action is currently limited to supporting message redrive from queues that are configured as dead-letter queues (DLQs) of other Amazon SQS queues only. Non-SQS queue sources of dead-letter queues, such as Lambda or Amazon SNS topics, are currently not supported. In dead-letter queues redrive context, the StartMessageMoveTask the source queue is the DLQ, while the destination queue can be the original source queue (from which the messages were driven to the dead-letter-queue), or a custom destination queue.
|
175
|
+
* Starts an asynchronous task to move messages from a specified source queue to a specified destination queue. This action is currently limited to supporting message redrive from queues that are configured as dead-letter queues (DLQs) of other Amazon SQS queues only. Non-SQS queue sources of dead-letter queues, such as Lambda or Amazon SNS topics, are currently not supported. In dead-letter queues redrive context, the StartMessageMoveTask the source queue is the DLQ, while the destination queue can be the original source queue (from which the messages were driven to the dead-letter-queue), or a custom destination queue. Only one active message movement task is supported per queue at any given time.
|
176
176
|
*/
|
177
177
|
startMessageMoveTask(params: SQS.Types.StartMessageMoveTaskRequest, callback?: (err: AWSError, data: SQS.Types.StartMessageMoveTaskResult) => void): Request<SQS.Types.StartMessageMoveTaskResult, AWSError>;
|
178
178
|
/**
|
179
|
-
* Starts an asynchronous task to move messages from a specified source queue to a specified destination queue. This action is currently limited to supporting message redrive from queues that are configured as dead-letter queues (DLQs) of other Amazon SQS queues only. Non-SQS queue sources of dead-letter queues, such as Lambda or Amazon SNS topics, are currently not supported. In dead-letter queues redrive context, the StartMessageMoveTask the source queue is the DLQ, while the destination queue can be the original source queue (from which the messages were driven to the dead-letter-queue), or a custom destination queue.
|
179
|
+
* Starts an asynchronous task to move messages from a specified source queue to a specified destination queue. This action is currently limited to supporting message redrive from queues that are configured as dead-letter queues (DLQs) of other Amazon SQS queues only. Non-SQS queue sources of dead-letter queues, such as Lambda or Amazon SNS topics, are currently not supported. In dead-letter queues redrive context, the StartMessageMoveTask the source queue is the DLQ, while the destination queue can be the original source queue (from which the messages were driven to the dead-letter-queue), or a custom destination queue. Only one active message movement task is supported per queue at any given time.
|
180
180
|
*/
|
181
181
|
startMessageMoveTask(callback?: (err: AWSError, data: SQS.Types.StartMessageMoveTaskResult) => void): Request<SQS.Types.StartMessageMoveTaskResult, AWSError>;
|
182
182
|
/**
|
@@ -481,7 +481,7 @@ declare namespace SQS {
|
|
481
481
|
*/
|
482
482
|
ApproximateNumberOfMessagesMoved?: Long;
|
483
483
|
/**
|
484
|
-
* The number of messages to be moved from the source queue. This number is obtained at the time of starting the message movement task.
|
484
|
+
* The number of messages to be moved from the source queue. This number is obtained at the time of starting the message movement task and is only included after the message movement task is selected to start.
|
485
485
|
*/
|
486
486
|
ApproximateNumberOfMessagesToMove?: NullableLong;
|
487
487
|
/**
|
@@ -588,8 +588,9 @@ declare namespace SQS {
|
|
588
588
|
export type MessageBodyAttributeMap = {[key: string]: MessageAttributeValue};
|
589
589
|
export type MessageBodySystemAttributeMap = {[key: string]: MessageSystemAttributeValue};
|
590
590
|
export type MessageList = Message[];
|
591
|
+
export type MessageSystemAttributeList = MessageSystemAttributeName[];
|
591
592
|
export type MessageSystemAttributeMap = {[key: string]: String};
|
592
|
-
export type MessageSystemAttributeName = "SenderId"|"SentTimestamp"|"ApproximateReceiveCount"|"ApproximateFirstReceiveTimestamp"|"SequenceNumber"|"MessageDeduplicationId"|"MessageGroupId"|"AWSTraceHeader"|"DeadLetterQueueSourceArn"|string;
|
593
|
+
export type MessageSystemAttributeName = "All"|"SenderId"|"SentTimestamp"|"ApproximateReceiveCount"|"ApproximateFirstReceiveTimestamp"|"SequenceNumber"|"MessageDeduplicationId"|"MessageGroupId"|"AWSTraceHeader"|"DeadLetterQueueSourceArn"|string;
|
593
594
|
export type MessageSystemAttributeNameForSends = "AWSTraceHeader"|string;
|
594
595
|
export interface MessageSystemAttributeValue {
|
595
596
|
/**
|
@@ -630,9 +631,13 @@ declare namespace SQS {
|
|
630
631
|
*/
|
631
632
|
QueueUrl: String;
|
632
633
|
/**
|
633
|
-
* A list of attributes that need to be returned along with each message. These attributes include: All – Returns all values. ApproximateFirstReceiveTimestamp – Returns the time the message was first received from the queue (epoch time in milliseconds). ApproximateReceiveCount – Returns the number of times a message has been received across all queues but not deleted. AWSTraceHeader – Returns the X-Ray trace header string. SenderId For a user, returns the user ID, for example ABCDEFGHI1JKLMNOPQ23R. For an IAM role, returns the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456. SentTimestamp – Returns the time the message was sent to the queue (epoch time in milliseconds). SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (for example, SSE-KMS or SSE-SQS). MessageDeduplicationId – Returns the value provided by the producer that calls the SendMessage action. MessageGroupId – Returns the value provided by the producer that calls the SendMessage action. Messages with the same MessageGroupId are returned in sequence. SequenceNumber – Returns the value provided by Amazon SQS.
|
634
|
+
* This parameter has been deprecated but will be supported for backward compatibility. To provide attribute names, you are encouraged to use MessageSystemAttributeNames. A list of attributes that need to be returned along with each message. These attributes include: All – Returns all values. ApproximateFirstReceiveTimestamp – Returns the time the message was first received from the queue (epoch time in milliseconds). ApproximateReceiveCount – Returns the number of times a message has been received across all queues but not deleted. AWSTraceHeader – Returns the X-Ray trace header string. SenderId For a user, returns the user ID, for example ABCDEFGHI1JKLMNOPQ23R. For an IAM role, returns the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456. SentTimestamp – Returns the time the message was sent to the queue (epoch time in milliseconds). SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (for example, SSE-KMS or SSE-SQS). MessageDeduplicationId – Returns the value provided by the producer that calls the SendMessage action. MessageGroupId – Returns the value provided by the producer that calls the SendMessage action. Messages with the same MessageGroupId are returned in sequence. SequenceNumber – Returns the value provided by Amazon SQS.
|
634
635
|
*/
|
635
636
|
AttributeNames?: AttributeNameList;
|
637
|
+
/**
|
638
|
+
* A list of attributes that need to be returned along with each message. These attributes include: All – Returns all values. ApproximateFirstReceiveTimestamp – Returns the time the message was first received from the queue (epoch time in milliseconds). ApproximateReceiveCount – Returns the number of times a message has been received across all queues but not deleted. AWSTraceHeader – Returns the X-Ray trace header string. SenderId For a user, returns the user ID, for example ABCDEFGHI1JKLMNOPQ23R. For an IAM role, returns the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456. SentTimestamp – Returns the time the message was sent to the queue (epoch time in milliseconds). SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (for example, SSE-KMS or SSE-SQS). MessageDeduplicationId – Returns the value provided by the producer that calls the SendMessage action. MessageGroupId – Returns the value provided by the producer that calls the SendMessage action. Messages with the same MessageGroupId are returned in sequence. SequenceNumber – Returns the value provided by Amazon SQS.
|
639
|
+
*/
|
640
|
+
MessageSystemAttributeNames?: MessageSystemAttributeList;
|
636
641
|
/**
|
637
642
|
* The name of the message attribute, where N is the index. The name can contain alphanumeric characters and the underscore (_), hyphen (-), and period (.). The name is case-sensitive and must be unique among all attribute names for the message. The name must not start with AWS-reserved prefixes such as AWS. or Amazon. (or any casing variants). The name must not start or end with a period (.), and it should not have periods in succession (..). The name can be up to 256 characters long. When using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying All or .* in your request. You can also use all message attributes starting with a prefix, for example bar.*.
|
638
643
|
*/
|
@@ -646,11 +651,11 @@ declare namespace SQS {
|
|
646
651
|
*/
|
647
652
|
VisibilityTimeout?: NullableInteger;
|
648
653
|
/**
|
649
|
-
* The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than WaitTimeSeconds. If no messages are available and the wait time expires, the call
|
654
|
+
* The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than WaitTimeSeconds. If no messages are available and the wait time expires, the call does not return a message list. To avoid HTTP errors, ensure that the HTTP response timeout for ReceiveMessage requests is longer than the WaitTimeSeconds parameter. For example, with the Java SDK, you can set HTTP transport settings using the NettyNioAsyncHttpClient for asynchronous clients, or the ApacheHttpClient for synchronous clients.
|
650
655
|
*/
|
651
656
|
WaitTimeSeconds?: NullableInteger;
|
652
657
|
/**
|
653
|
-
* This parameter applies only to FIFO (first-in-first-out) queues. The token used for deduplication of ReceiveMessage calls. If a networking issue occurs after a ReceiveMessage action, and instead of a response you receive a generic error, it is possible to retry the same action with an identical ReceiveRequestAttemptId to retrieve the same set of messages, even if their visibility timeout has not yet expired. You can use ReceiveRequestAttemptId only for 5 minutes after a ReceiveMessage action. When you set FifoQueue, a caller of the ReceiveMessage action can provide a ReceiveRequestAttemptId explicitly.
|
658
|
+
* This parameter applies only to FIFO (first-in-first-out) queues. The token used for deduplication of ReceiveMessage calls. If a networking issue occurs after a ReceiveMessage action, and instead of a response you receive a generic error, it is possible to retry the same action with an identical ReceiveRequestAttemptId to retrieve the same set of messages, even if their visibility timeout has not yet expired. You can use ReceiveRequestAttemptId only for 5 minutes after a ReceiveMessage action. When you set FifoQueue, a caller of the ReceiveMessage action can provide a ReceiveRequestAttemptId explicitly. It is possible to retry the ReceiveMessage action with the same ReceiveRequestAttemptId if none of the messages have been modified (deleted or had their visibility changes). During a visibility timeout, subsequent calls with the same ReceiveRequestAttemptId return the same messages and receipt handles. If a retry occurs within the deduplication interval, it resets the visibility timeout. For more information, see Visibility Timeout in the Amazon SQS Developer Guide. If a caller of the ReceiveMessage action still processes messages when the visibility timeout expires and messages become visible, another worker consuming from the same queue can receive the same messages and therefore process duplicates. Also, if a consumer whose message processing time is longer than the visibility timeout tries to delete the processed messages, the action fails with an error. To mitigate this effect, ensure that your application observes a safe threshold before the visibility timeout expires and extend the visibility timeout as necessary. While messages with a particular MessageGroupId are invisible, no more messages belonging to the same MessageGroupId are returned until the visibility timeout expires. You can still receive messages with another MessageGroupId as long as it is also visible. If a caller of ReceiveMessage can't track the ReceiveRequestAttemptId, no retries work until the original visibility timeout expires. As a result, delays might occur but the messages in the queue remain in a strict order. The maximum length of ReceiveRequestAttemptId is 128 characters. ReceiveRequestAttemptId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). For best practices of using ReceiveRequestAttemptId, see Using the ReceiveRequestAttemptId Request Parameter in the Amazon SQS Developer Guide.
|
654
659
|
*/
|
655
660
|
ReceiveRequestAttemptId?: String;
|
656
661
|
}
|
@@ -774,7 +779,7 @@ declare namespace SQS {
|
|
774
779
|
*/
|
775
780
|
MessageDeduplicationId?: String;
|
776
781
|
/**
|
777
|
-
* This parameter applies only to FIFO (first-in-first-out) queues. The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use MessageGroupId values (for example, session data for multiple users). In this scenario, multiple consumers can process the queue, but the session data of each user is processed in a FIFO fashion. You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails. ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId, the messages are sorted by time sent. The caller can't specify a MessageGroupId. The length of MessageGroupId is 128 characters. Valid values: alphanumeric characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon SQS Developer Guide. MessageGroupId is required for FIFO queues. You can't use it for Standard queues.
|
782
|
+
* This parameter applies only to FIFO (first-in-first-out) queues. The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use MessageGroupId values (for example, session data for multiple users). In this scenario, multiple consumers can process the queue, but the session data of each user is processed in a FIFO fashion. You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails. ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId, the messages are sorted by time sent. The caller can't specify a MessageGroupId. The maximum length of MessageGroupId is 128 characters. Valid values: alphanumeric characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon SQS Developer Guide. MessageGroupId is required for FIFO queues. You can't use it for Standard queues.
|
778
783
|
*/
|
779
784
|
MessageGroupId?: String;
|
780
785
|
}
|