Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE, NEUTRAL, MIXED, or NEGATIVE, in each one.
Inspects the text of a batch of documents for the syntax and part of speech of the words in the document and returns information about them. For more information, see Syntax in the Comprehend Developer Guide.
", "BatchDetectTargetedSentiment": "Inspects a batch of documents and returns a sentiment analysis for each entity identified in the documents.
For more information about targeted sentiment, see Targeted sentiment.
", - "ClassifyDocument": "Creates a new document classification request to analyze a single document in real-time, using a previously created and trained custom model and an endpoint.
", + "ClassifyDocument": "Creates a new document classification request to analyze a single document in real-time, using a previously created and trained custom model and an endpoint.
You can input plain text or you can upload a single-page input document (text, PDF, Word, or image).
If the system detects errors while processing a page in the input document, the API response includes an entry in Errors that describes the errors.
If the system detects a document-level error in your input document, the API returns an InvalidRequestException error response. For details about this exception, see Errors in semi-structured documents in the Comprehend Developer Guide.
Analyzes input text for the presence of personally identifiable information (PII) and returns the labels of identified PII entity types such as name, address, bank account number, or phone number.
", "CreateDocumentClassifier": "Creates a new document classifier that you can use to categorize documents. To create a classifier, you provide a set of training documents that labeled with the categories that you want to use. After the classifier is trained you can use it to categorize a set of labeled documents into the categories. For more information, see Document Classification in the Comprehend Developer Guide.
", "CreateEndpoint": "Creates a model-specific endpoint for synchronous inference for a previously trained custom model For information about endpoints, see Managing endpoints.
", @@ -31,7 +31,7 @@ "DescribeTargetedSentimentDetectionJob": "Gets the properties associated with a targeted sentiment detection job. Use this operation to get the status of the job.
", "DescribeTopicsDetectionJob": "Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job.
", "DetectDominantLanguage": "Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.
", - "DetectEntities": "Inspects text for named entities, and returns information about them. For more information, about named entities, see Entities in the Comprehend Developer Guide.
", + "DetectEntities": "Detects named entities in input text when you use the pre-trained model. Detects custom entities if you have a custom entity recognition model.
When detecting named entities using the pre-trained model, use plain text as the input. For more information about named entities, see Entities in the Comprehend Developer Guide.
When you use a custom entity recognition model, you can input plain text or you can upload a single-page input document (text, PDF, Word, or image).
If the system detects errors while processing a page in the input document, the API response includes an entry in Errors for each error.
If the system detects a document-level error in your input document, the API returns an InvalidRequestException error response. For details about this exception, see Errors in semi-structured documents in the Comprehend Developer Guide.
Detects the key noun phrases found in the text.
", "DetectPiiEntities": "Inspects the input text for entities that contain personally identifiable information (PII) and returns information about them.
", "DetectSentiment": "Inspects text and returns an inference of the prevailing sentiment (POSITIVE, NEUTRAL, MIXED, or NEGATIVE).
Information about each word or line of text in the input document.
For additional information, see Block in the Amazon Textract API reference.
", + "refs": { + "ListOfBlocks$member": null + } + }, + "BlockReference": { + "base": "A reference to a block.
", + "refs": { + "ListOfBlockReferences$member": null + } + }, + "BlockType": { + "base": null, + "refs": { + "Block$BlockType": "The block represents a line of text or one word of text.
WORD - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
LINE - A string of tab-delimited, contiguous words that are detected on a document page
The bounding box around the detected page or around an element on a document page. The left (x-coordinate) and top (y-coordinate) are coordinates that represent the top and left sides of the bounding box. Note that the upper-left corner of the image is the origin (0,0).
For additional information, see BoundingBox in the Amazon Textract API reference.
", + "refs": { + "Geometry$BoundingBox": "An axis-aligned coarse representation of the location of the recognized item on the document page.
" + } + }, + "ChildBlock": { + "base": "Nested block contained within a block.
", + "refs": { + "ListOfChildBlocks$member": null + } + }, "ClassifierEvaluationMetrics": { "base": "Describes the result metrics for the test data associated with an documentation classifier.
", "refs": { @@ -337,7 +367,7 @@ "refs": { "CreateEndpointRequest$ModelArn": "The Amazon Resource Number (ARN) of the model to which the endpoint will be attached.
", "DeleteResourcePolicyRequest$ResourceArn": "The Amazon Resource Name (ARN) of the custom model version that has the policy to delete.
", - "DescribeResourcePolicyRequest$ResourceArn": "The Amazon Resource Name (ARN) of the policy to describe.
", + "DescribeResourcePolicyRequest$ResourceArn": "The Amazon Resource Name (ARN) of the custom model version that has the resource policy.
", "EndpointFilter$ModelArn": "The Amazon Resource Number (ARN) of the model to which the endpoint is attached.
", "EndpointProperties$ModelArn": "The Amazon Resource Number (ARN) of the model to which the endpoint is attached.
", "EndpointProperties$DesiredModelArn": "ARN of the new model to use for updating an existing endpoint. This ARN is going to be different from the model ARN when the update is in progress
", @@ -395,10 +425,10 @@ "CustomerInputString": { "base": null, "refs": { - "ClassifyDocumentRequest$Text": "The document text to be analyzed.
", + "ClassifyDocumentRequest$Text": "The document text to be analyzed. If you enter text using this parameter, do not use the Bytes parameter.
A UTF-8 text string. The string must contain at least 20 characters. The maximum string size is 100 KB.
", - "DetectEntitiesRequest$Text": "A UTF-8 text string. The maximum string size is 100 KB.
", + "DetectEntitiesRequest$Text": "A UTF-8 text string. The maximum string size is 100 KB. If you enter text using this parameter, do not use the Bytes parameter.
A UTF-8 text string. The string must contain less than 100 KB of UTF-8 encoded characters.
", "DetectSentimentRequest$Text": "A UTF-8 text string. The maximum string size is 5 KB.
Amazon Comprehend performs real-time sentiment analysis on the first 500 characters of the input text and ignores any additional text in the input.
A UTF-8 string. The maximum string size is 5 KB.
", @@ -770,14 +800,21 @@ "ListOfLabels$member": null } }, + "DocumentMetadata": { + "base": "Information about the document, discovered during text extraction.
", + "refs": { + "ClassifyDocumentResponse$DocumentMetadata": "Extraction information about the document. This field is present in the response only if your request includes the Byte parameter.
Information about the document, discovered during text extraction. This field is present in the response only if your request used the Byte parameter.
This enum field will start with two values which will apply to PDFs:
TEXTRACT_DETECT_DOCUMENT_TEXT - The service calls DetectDocumentText for PDF documents per page.
TEXTRACT_ANALYZE_DOCUMENT - The service calls AnalyzeDocument for PDF documents per page.
This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.
TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.
A list of the types of analyses to perform. This field specifies what feature types need to be extracted from the document where entity recognition is expected.
TABLES - Add TABLES to the list to return information about the tables that are detected in the input document.
FORMS - Add FORMS to return detected form data.
Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns additional information about any tables that are detected in the input document.
FORMS - Returns additional information about any forms that are detected in the input document.
This enum field provides two values:
SERVICE_DEFAULT - use service defaults for Document reading. For Digital PDF it would mean using an internal parser instead of Textract APIs
FORCE_DOCUMENT_READ_ACTION - Always use specified action for DocumentReadAction, including Digital PDF.
Determines the text extraction actions for PDF files. Enter one of the following values:
SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.
FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.
The input properties for a topic detection job.
", + "base": "Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
By default, Amazon Comprehend performs the following actions to extract text from files, based on the input file type:
Word files - Amazon Comprehend parser extracts the text.
Digital PDF files - Amazon Comprehend parser extracts the text.
Image files and scanned PDF files - Amazon Comprehend uses the Amazon Textract DetectDocumentText API to extract the text.
DocumentReaderConfig does not apply to plain text files or Word files.
For image files and PDF documents, you can override these default actions using the fields listed below. For more information, see Setting text extraction options.
", + "refs": { + "ClassifyDocumentRequest$DocumentReaderConfig": "Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
", + "DetectEntitiesRequest$DocumentReaderConfig": "Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
", + "InputDataConfig$DocumentReaderConfig": "Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
" + } + }, + "DocumentType": { + "base": null, + "refs": { + "DocumentTypeListItem$Type": "Document type.
" + } + }, + "DocumentTypeListItem": { + "base": "Document type for each page in the document.
", "refs": { - "InputDataConfig$DocumentReaderConfig": "The document reader config field applies only for InputDataConfig of StartEntitiesDetectionJob.
Use DocumentReaderConfig to provide specifications about how you want your inference documents read. Currently it applies for PDF documents in StartEntitiesDetectionJob custom inference.
" + "ListOfDocumentType$member": null } }, "DominantLanguage": { @@ -1009,7 +1060,7 @@ "EntityType": { "base": null, "refs": { - "Entity$Type": "The entity's type.
" + "Entity$Type": "The entity type. For entity detection using the built-in model, this field contains one of the standard entity types listed below.
For custom entity detection, this field contains one of the entity types that you specified when you trained your custom model.
" } }, "EntityTypeName": { @@ -1036,6 +1087,12 @@ "EntityTypesList$member": null } }, + "ErrorsListItem": { + "base": "Text extraction encountered one or more page-level errors in the input document.
The ErrorCode contains one of the following values:
TEXTRACT_BAD_PAGE - Amazon Textract cannot read the page. For more information about page limits in Amazon Textract, see Page Quotas in Amazon Textract.
TEXTRACT_PROVISIONED_THROUGHPUT_EXCEEDED - The number of requests exceeded your throughput limit. For more information about throughput quotas in Amazon Textract, see Default quotas in Amazon Textract.
PAGE_CHARACTERS_EXCEEDED - Too many text characters on the page (10,000 characters maximum).
PAGE_SIZE_EXCEEDED - The maximum page size is 10 MB.
INTERNAL_SERVER_ERROR - The request encountered a service issue. Try the API request again.
A list containing the properties of each job that is returned.
" } }, + "ExtractedCharactersListItem": { + "base": "Array of the number of characters extracted from each page.
", + "refs": { + "ListOfExtractedCharacters$member": null + } + }, "Float": { "base": null, "refs": { + "BoundingBox$Height": "The height of the bounding box as a ratio of the overall document page height.
", + "BoundingBox$Left": "The left coordinate of the bounding box as a ratio of overall document page width.
", + "BoundingBox$Top": "The top coordinate of the bounding box as a ratio of overall document page height.
", + "BoundingBox$Width": "The width of the bounding box as a ratio of the overall document page width.
", "DocumentClass$Score": "The confidence score that Amazon Comprehend has this class correctly attributed.
", "DocumentLabel$Score": "The confidence score that Amazon Comprehend has this label correctly attributed.
", "DominantLanguage$Score": "The level of confidence that Amazon Comprehend has in the accuracy of the detection.
", @@ -1072,6 +1139,8 @@ "KeyPhrase$Score": "The level of confidence that Amazon Comprehend has in the accuracy of the detection.
", "PartOfSpeechTag$Score": "The confidence that Amazon Comprehend has that the part of speech was correctly identified.
", "PiiEntity$Score": "The level of confidence that Amazon Comprehend has in the accuracy of the detection.
", + "Point$X": "The value of the X coordinate for a point on a polygon
", + "Point$Y": "The value of the Y coordinate for a point on a polygon
", "SentimentScore$Positive": "The level of confidence that Amazon Comprehend has in the accuracy of its detection of the POSITIVE sentiment.
The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEGATIVE sentiment.
The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEUTRAL sentiment.
The confidence that all the entities mentioned in the group relate to the same entity.
" } }, + "Geometry": { + "base": "Information about the location of items on a document page.
For additional information, see Geometry in the Amazon Textract API reference.
", + "refs": { + "Block$Geometry": "Co-ordinates of the rectangle or polygon that contains the text.
" + } + }, "IamRoleArn": { "base": null, "refs": { @@ -1132,7 +1207,7 @@ } }, "InputDataConfig": { - "base": "The input properties for an inference job.
", + "base": "The input properties for an inference job. The document reader config field applies only to non-text inputs for custom analysis.
", "refs": { "DocumentClassificationJobProperties$InputDataConfig": "The input data configuration that you supplied when you created the document classification job.
", "DominantLanguageDetectionJobProperties$InputDataConfig": "The input data configuration that you supplied when you created the dominant language detection job.
", @@ -1171,16 +1246,28 @@ "BatchDetectSyntaxItemResult$Index": "The zero-based index of the document in the input list.
", "BatchDetectTargetedSentimentItemResult$Index": "The zero-based index of this result in the input list.
", "BatchItemError$Index": "The zero-based index of the document in the input list.
", + "Block$Page": "Page number where the block appears.
", + "BlockReference$BeginOffset": "Offset of the start of the block within its parent block.
", + "BlockReference$EndOffset": "Offset of the end of the block within its parent block.
", + "ChildBlock$BeginOffset": "Offset of the start of the child block within its parent block.
", + "ChildBlock$EndOffset": "Offset of the end of the child block within its parent block.
", "ClassifierMetadata$NumberOfLabels": "The number of labels in the input data.
", "ClassifierMetadata$NumberOfTrainedDocuments": "The number of documents in the input data that were used to train the classifier. Typically this is 80 to 90 percent of the input documents.
", "ClassifierMetadata$NumberOfTestDocuments": "The number of documents in the input data that were used to test the classifier. Typically this is 10 to 20 percent of the input documents, up to 10,000 documents.
", + "DocumentClass$Page": "Page number in the input document. This field is present in the response only if your request includes the Byte parameter.
The number of versions you created.
", - "Entity$BeginOffset": "The zero-based offset from the beginning of the source text to the first character in the entity.
", - "Entity$EndOffset": "The zero-based offset from the beginning of the source text to the last character in the entity.
", + "DocumentLabel$Page": "Page number where the label occurs. This field is present in the response only if your request includes the Byte parameter.
Number of pages in the document.
", + "DocumentTypeListItem$Page": "Page number.
", + "Entity$BeginOffset": "The zero-based offset from the beginning of the source text to the first character in the entity.
This field is empty for non-text input.
", + "Entity$EndOffset": "The zero-based offset from the beginning of the source text to the last character in the entity.
This field is empty for non-text input.
", "EntityRecognizerMetadata$NumberOfTrainedDocuments": "The number of documents in the input data that were used to train the entity recognizer. Typically this is 80 to 90 percent of the input documents.
", "EntityRecognizerMetadata$NumberOfTestDocuments": "The number of documents in the input data that were used to test the entity recognizer. Typically this is 10 to 20 percent of the input documents.
", "EntityRecognizerMetadataEntityTypesListItem$NumberOfTrainMentions": "Indicates the number of times the given entity type was seen in the training data.
", "EntityRecognizerSummary$NumberOfVersions": "The number of versions you created.
", + "ErrorsListItem$Page": "Page number where the error occurred.
", + "ExtractedCharactersListItem$Page": "Page number.
", + "ExtractedCharactersListItem$Count": "Number of characters extracted from each page.
", "KeyPhrase$BeginOffset": "The zero-based offset from the beginning of the source text to the first character in the key phrase.
", "KeyPhrase$EndOffset": "The zero-based offset from the beginning of the source text to the last character in the key phrase.
", "ListOfDescriptiveMentionIndices$member": null, @@ -1204,11 +1291,29 @@ "refs": { } }, + "InvalidRequestDetail": { + "base": "Provides additional detail about why the request failed:
Document size is too large - Check the size of your file and resubmit the request.
Document type is not supported - Check the file type and resubmit the request.
Too many pages in the document - Check the number of pages in your file and resubmit the request.
Access denied to Amazon Textract - Verify that your account has permission to use Amazon Textract API operations and resubmit the request.
Reason code is INVALID_DOCUMENT.
The request is invalid.
", "refs": { } }, + "InvalidRequestReason": { + "base": null, + "refs": { + "InvalidRequestException$Reason": null + } + }, "JobId": { "base": null, "refs": { @@ -1407,8 +1512,8 @@ "BatchDetectTargetedSentimentRequest$LanguageCode": "The language of the input documents. Currently, English is the only supported language.
", "ContainsPiiEntitiesRequest$LanguageCode": "The language of the input documents. Currently, English is the only valid language.
", "CreateDocumentClassifierRequest$LanguageCode": "The language of the input documents. You can specify any of the following languages supported by Amazon Comprehend: German (\"de\"), English (\"en\"), Spanish (\"es\"), French (\"fr\"), Italian (\"it\"), or Portuguese (\"pt\"). All documents must be in the same language.
", - "CreateEntityRecognizerRequest$LanguageCode": "You can specify any of the following languages supported by Amazon Comprehend: English (\"en\"), Spanish (\"es\"), French (\"fr\"), Italian (\"it\"), German (\"de\"), or Portuguese (\"pt\"). All documents must be in the same language.
", - "DetectEntitiesRequest$LanguageCode": "The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.
If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.
", + "CreateEntityRecognizerRequest$LanguageCode": "You can specify any of the following languages: English (\"en\"), Spanish (\"es\"), French (\"fr\"), Italian (\"it\"), German (\"de\"), or Portuguese (\"pt\"). If you plan to use this entity recognizer with PDF, Word, or image input files, you must specify English as the language. All training documents must be in the same language.
", + "DetectEntitiesRequest$LanguageCode": "The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.
All input documents must be in the same language.
", "DetectKeyPhrasesRequest$LanguageCode": "The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.
", "DetectPiiEntitiesRequest$LanguageCode": "The language of the input documents. Currently, English is the only valid language.
", "DetectSentimentRequest$LanguageCode": "The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.
", @@ -1529,6 +1634,24 @@ "refs": { } }, + "ListOfBlockReferences": { + "base": null, + "refs": { + "Entity$BlockReferences": "A reference to each block for this entity. This field is empty for plain-text input.
" + } + }, + "ListOfBlocks": { + "base": null, + "refs": { + "DetectEntitiesResponse$Blocks": "Information about each block of text in the input document. Blocks are nested. A page block contains a block for each line of text, which contains a block for each word.
The Block content for a Word input document does not include a Geometry field.
The Block field is not present in the response for plain-text inputs.
List of child blocks within this block.
" + } + }, "ListOfClasses": { "base": null, "refs": { @@ -1580,7 +1703,14 @@ "ListOfDocumentReadFeatureTypes": { "base": null, "refs": { - "DocumentReaderConfig$FeatureTypes": "Specifies how the text in an input file should be processed:
" + "DocumentReaderConfig$FeatureTypes": "Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns information about any tables that are detected in the input document.
FORMS - Returns information and the data from any forms that are detected in the input document.
The document type for each page in the input document. This field is present in the response only if your request includes the Byte parameter.
The document type for each page in the input document. This field is present in the response only if your request used the Byte parameter.
The labels used in the document being analyzed. Individual labels represent personally identifiable information (PII) entity types.
" } }, + "ListOfErrors": { + "base": null, + "refs": { + "ClassifyDocumentResponse$Errors": "Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.
", + "DetectEntitiesResponse$Errors": "Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.
" + } + }, + "ListOfExtractedCharacters": { + "base": null, + "refs": { + "DocumentMetadata$ExtractedCharacters": "List of pages in the document, with the number of characters extracted from each page.
" + } + }, "ListOfKeyPhrases": { "base": null, "refs": { @@ -1634,6 +1777,12 @@ "RedactionConfig$PiiEntityTypes": "An array of the types of PII entities that Amazon Comprehend detects in the input text for your request.
" } }, + "ListOfRelationships": { + "base": null, + "refs": { + "Block$Relationships": "A list of child blocks of the current block. For example, a LINE object has child blocks for each WORD block that's part of the line of text.
" + } + }, "ListOfSyntaxTokens": { "base": null, "refs": { @@ -1768,6 +1917,12 @@ "TopicsDetectionJobProperties$OutputDataConfig": "The output data configuration supplied when you created the topic detection job.
" } }, + "PageBasedErrorCode": { + "base": null, + "refs": { + "ErrorsListItem$ErrorCode": "Error code for the cause of the error.
" + } + }, "PartOfSpeechTag": { "base": "Identifies the part of speech represented by the token and gives the confidence that Amazon Comprehend has that the part of speech was correctly identified. For more information about the parts of speech that Amazon Comprehend can identify, see Syntax in the Comprehend Developer Guide.
", "refs": { @@ -1832,6 +1987,12 @@ "PiiEntitiesDetectionJobProperties$OutputDataConfig": "The output data configuration that you supplied when you created the PII entities detection job.
" } }, + "Point": { + "base": "The X and Y coordinates of a point on a document page.
For additional information, see Point in the Amazon Textract API reference.
", + "refs": { + "Polygon$member": null + } + }, "Policy": { "base": null, "refs": { @@ -1850,6 +2011,12 @@ "PutResourcePolicyResponse$PolicyRevisionId": "The revision ID of the policy. Each time you modify a policy, Amazon Comprehend assigns a new revision ID, and it deletes the prior version of the policy.
" } }, + "Polygon": { + "base": null, + "refs": { + "Geometry$Polygon": "Within the bounding box, a fine-grained polygon around the recognized item.
" + } + }, "PutResourcePolicyRequest": { "base": null, "refs": { @@ -1867,6 +2034,18 @@ "StartPiiEntitiesDetectionJobRequest$RedactionConfig": "Provides configuration parameters for PII entity redaction.
This parameter is required if you set the Mode parameter to ONLY_REDACTION. In that case, you must provide a RedactionConfig definition that includes the PiiEntityTypes parameter.
Only supported relationship is a child relationship.
" + } + }, + "RelationshipsListItem": { + "base": "List of child blocks for the current block.
", + "refs": { + "ListOfRelationships$member": null + } + }, "ResourceInUseException": { "base": "The specified resource name is already in use. Use a different name and try your request again.
", "refs": { @@ -1918,6 +2097,13 @@ "VpcConfig$SecurityGroupIds": "The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by \"sg-\", for instance: \"sg-03b388029b0a285ea\". For more information, see Security Groups for your VPC.
" } }, + "SemiStructuredDocumentBlob": { + "base": null, + "refs": { + "ClassifyDocumentRequest$Bytes": "Use the Bytes parameter to input a text, PDF, Word or image file. You can also use the Bytes parameter to input an Amazon Textract DetectDocumentText or AnalyzeDocument output file.
Provide the input document as a sequence of base64-encoded bytes. If your code uses an Amazon Web Services SDK to classify documents, the SDK may encode the document file bytes for you.
The maximum length of this field depends on the input document type. For details, see Inputs for real-time custom analysis in the Comprehend Developer Guide.
If you use the Bytes parameter, do not use the Text parameter.
This field applies only when you use a custom entity recognition model that was trained with PDF annotations. For other cases, enter your text input in the Text field.
Use the Bytes parameter to input a text, PDF, Word or image file. Using a plain-text file in the Bytes parameter is equivelent to using the Text parameter (the Entities field in the response is identical).
You can also use the Bytes parameter to input an Amazon Textract DetectDocumentText or AnalyzeDocument output file.
Provide the input document as a sequence of base64-encoded bytes. If your code uses an Amazon Web Services SDK to detect entities, the SDK may encode the document file bytes for you.
The maximum length of this field depends on the input document type. For details, see Inputs for real-time custom analysis in the Comprehend Developer Guide.
If you use the Bytes parameter, do not use the Text parameter.
Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.
", "refs": { @@ -2145,6 +2331,10 @@ "BatchItemError$ErrorCode": "The numeric error code of the error.
", "BatchItemError$ErrorMessage": "A text description of the error.
", "BatchSizeLimitExceededException$Message": null, + "Block$Id": "Unique identifier for the block.
", + "Block$Text": "The word or line of text extracted from the block.
", + "BlockReference$BlockId": "Unique identifier for the block.
", + "ChildBlock$ChildBlockId": "Unique identifier for the child block.
", "ConcurrentModificationException$Message": null, "ContainsPiiEntitiesRequest$Text": "A UTF-8 text string. The maximum string size is 100 KB.
", "DetectPiiEntitiesRequest$Text": "A UTF-8 text string. The maximum string size is 100 KB.
", @@ -2152,6 +2342,7 @@ "DocumentLabel$Name": "The name of the label.
", "DominantLanguage$LanguageCode": "The RFC 5646 language code for the dominant language. For more information about RFC 5646, see Tags for Identifying Languages on the IETF Tools web site.
", "Entity$Text": "The text of the entity.
", + "ErrorsListItem$ErrorMessage": "Text message explaining the reason for the error.
", "InternalServerException$Message": null, "InvalidFilterException$Message": null, "InvalidRequestException$Message": null, @@ -2190,6 +2381,7 @@ "ResourceLimitExceededException$Message": null, "ResourceNotFoundException$Message": null, "ResourceUnavailableException$Message": null, + "StringList$member": null, "SyntaxToken$Text": "The word that was recognized in the source text.
", "TargetedSentimentMention$Text": "The text in the document that identifies the entity.
", "TextSizeLimitExceededException$Message": null, @@ -2199,6 +2391,12 @@ "UnsupportedLanguageException$Message": null } }, + "StringList": { + "base": null, + "refs": { + "RelationshipsListItem$Ids": "Identifers of the child blocks.
" + } + }, "SubnetId": { "base": null, "refs": { diff --git a/models/apis/comprehend/2017-11-27/endpoint-rule-set-1.json b/models/apis/comprehend/2017-11-27/endpoint-rule-set-1.json new file mode 100644 index 00000000000..62da72bdfe6 --- /dev/null +++ b/models/apis/comprehend/2017-11-27/endpoint-rule-set-1.json @@ -0,0 +1,315 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": true, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://comprehend-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://comprehend-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://comprehend.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://comprehend.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] +} \ No newline at end of file diff --git a/models/apis/comprehend/2017-11-27/endpoint-tests-1.json b/models/apis/comprehend/2017-11-27/endpoint-tests-1.json new file mode 100644 index 00000000000..7d2411ad289 --- /dev/null +++ b/models/apis/comprehend/2017-11-27/endpoint-tests-1.json @@ -0,0 +1,1235 @@ +{ + "testCases": [ + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.ap-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ap-south-1" + } + }, + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ap-south-1" + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.ap-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ap-south-1" + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-south-1" + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.ca-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ca-central-1" + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ca-central-1" + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.ca-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ca-central-1" + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ca-central-1" + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.eu-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "eu-central-1" + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "eu-central-1" + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.eu-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "eu-central-1" + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "eu-central-1" + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.us-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-west-1" + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-west-1" + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.us-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-west-1" + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.us-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-west-1" + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.us-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-west-2" + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-west-2" + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.us-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-west-2" + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.us-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-west-2" + } + }, + { + "documentation": "For region af-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.af-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "af-south-1" + } + }, + { + "documentation": "For region af-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.af-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "af-south-1" + } + }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.af-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "af-south-1" + } + }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.af-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "af-south-1" + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.eu-north-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "eu-north-1" + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.eu-north-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "eu-north-1" + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.eu-north-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "eu-north-1" + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.eu-north-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "eu-north-1" + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.eu-west-3.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "eu-west-3" + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "eu-west-3" + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.eu-west-3.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "eu-west-3" + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "eu-west-3" + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.eu-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "eu-west-2" + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "eu-west-2" + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.eu-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "eu-west-2" + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "eu-west-2" + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.eu-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.eu-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.ap-northeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.ap-northeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.ap-northeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ap-northeast-1" + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ap-northeast-1" + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.ap-northeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ap-northeast-1" + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-northeast-1" + } + }, + { + "documentation": "For region me-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.me-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "me-south-1" + } + }, + { + "documentation": "For region me-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.me-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "me-south-1" + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.me-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "me-south-1" + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.me-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "me-south-1" + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.sa-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "sa-east-1" + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "sa-east-1" + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.sa-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "sa-east-1" + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "sa-east-1" + } + }, + { + "documentation": "For region ap-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.ap-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ap-east-1" + } + }, + { + "documentation": "For region ap-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.ap-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ap-east-1" + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.ap-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ap-east-1" + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.ap-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-east-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.us-gov-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-gov-west-1" + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-gov-west-1" + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.us-gov-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-gov-west-1" + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-gov-west-1" + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.ap-southeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ap-southeast-1" + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ap-southeast-1" + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.ap-southeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ap-southeast-1" + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-southeast-1" + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.ap-southeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ap-southeast-2" + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ap-southeast-2" + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.ap-southeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ap-southeast-2" + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-southeast-2" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.us-east-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-east-2" + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-2" + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.us-east-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-2" + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.us-east-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-2" + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "cn-northwest-1" + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend-fips.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "cn-northwest-1" + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://comprehend.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "cn-northwest-1" + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://comprehend.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "cn-northwest-1" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" +} \ No newline at end of file diff --git a/models/apis/comprehend/2017-11-27/paginators-1.json b/models/apis/comprehend/2017-11-27/paginators-1.json index a1567d485de..d95d1ab4d68 100644 --- a/models/apis/comprehend/2017-11-27/paginators-1.json +++ b/models/apis/comprehend/2017-11-27/paginators-1.json @@ -2,63 +2,75 @@ "pagination": { "ListDocumentClassificationJobs": { "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults" + "limit_key": "MaxResults", + "output_token": "NextToken" }, "ListDocumentClassifierSummaries": { "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults" + "limit_key": "MaxResults", + "output_token": "NextToken" }, "ListDocumentClassifiers": { "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults" + "limit_key": "MaxResults", + "output_token": "NextToken" }, "ListDominantLanguageDetectionJobs": { "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken" + }, + "ListEndpoints": { + "input_token": "NextToken", + "limit_key": "MaxResults", "output_token": "NextToken", - "limit_key": "MaxResults" + "result_key": "EndpointPropertiesList" }, "ListEntitiesDetectionJobs": { "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults" + "limit_key": "MaxResults", + "output_token": "NextToken" }, "ListEntityRecognizerSummaries": { "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults" + "limit_key": "MaxResults", + "output_token": "NextToken" }, "ListEntityRecognizers": { "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults" + "limit_key": "MaxResults", + "output_token": "NextToken" }, "ListEventsDetectionJobs": { "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults" + "limit_key": "MaxResults", + "output_token": "NextToken" }, "ListKeyPhrasesDetectionJobs": { "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken" + }, + "ListPiiEntitiesDetectionJobs": { + "input_token": "NextToken", + "limit_key": "MaxResults", "output_token": "NextToken", - "limit_key": "MaxResults" + "result_key": "PiiEntitiesDetectionJobPropertiesList" }, "ListSentimentDetectionJobs": { "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults" + "limit_key": "MaxResults", + "output_token": "NextToken" }, "ListTargetedSentimentDetectionJobs": { "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults" + "limit_key": "MaxResults", + "output_token": "NextToken" }, "ListTopicsDetectionJobs": { "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults" + "limit_key": "MaxResults", + "output_token": "NextToken" } } -} +} \ No newline at end of file diff --git a/models/apis/gamelift/2015-10-01/api-2.json b/models/apis/gamelift/2015-10-01/api-2.json index 7ae1d494691..63459bfa416 100644 --- a/models/apis/gamelift/2015-10-01/api-2.json +++ b/models/apis/gamelift/2015-10-01/api-2.json @@ -110,7 +110,8 @@ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"InvalidFleetStatusException"}, - {"shape":"UnsupportedRegionException"} + {"shape":"UnsupportedRegionException"}, + {"shape":"ConflictException"} ] }, "CreateGameServerGroup":{ @@ -168,6 +169,23 @@ {"shape":"TaggingFailedException"} ] }, + "CreateLocation":{ + "name":"CreateLocation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateLocationInput"}, + "output":{"shape":"CreateLocationOutput"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InvalidRequestException"}, + {"shape":"LimitExceededException"}, + {"shape":"ConflictException"}, + {"shape":"TaggingFailedException"}, + {"shape":"InternalServiceException"} + ] + }, "CreateMatchmakingConfiguration":{ "name":"CreateMatchmakingConfiguration", "http":{ @@ -195,6 +213,7 @@ "output":{"shape":"CreateMatchmakingRuleSetOutput"}, "errors":[ {"shape":"InvalidRequestException"}, + {"shape":"LimitExceededException"}, {"shape":"InternalServiceException"}, {"shape":"UnsupportedRegionException"}, {"shape":"TaggingFailedException"} @@ -375,6 +394,21 @@ {"shape":"TaggingFailedException"} ] }, + "DeleteLocation":{ + "name":"DeleteLocation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteLocationInput"}, + "output":{"shape":"DeleteLocationOutput"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InvalidRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalServiceException"} + ] + }, "DeleteMatchmakingConfiguration":{ "name":"DeleteMatchmakingConfiguration", "http":{ @@ -466,6 +500,21 @@ {"shape":"InternalServiceException"} ] }, + "DeregisterCompute":{ + "name":"DeregisterCompute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterComputeInput"}, + "output":{"shape":"DeregisterComputeOutput"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InvalidRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalServiceException"} + ] + }, "DeregisterGameServer":{ "name":"DeregisterGameServer", "http":{ @@ -510,6 +559,21 @@ {"shape":"InternalServiceException"} ] }, + "DescribeCompute":{ + "name":"DescribeCompute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeComputeInput"}, + "output":{"shape":"DescribeComputeOutput"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InvalidRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalServiceException"} + ] + }, "DescribeEC2InstanceLimits":{ "name":"DescribeEC2InstanceLimits", "http":{ @@ -630,7 +694,8 @@ {"shape":"InternalServiceException"}, {"shape":"NotFoundException"}, {"shape":"InvalidRequestException"}, - {"shape":"UnauthorizedException"} + {"shape":"UnauthorizedException"}, + {"shape":"UnsupportedRegionException"} ] }, "DescribeFleetUtilization":{ @@ -906,6 +971,36 @@ {"shape":"InternalServiceException"} ] }, + "GetComputeAccess":{ + "name":"GetComputeAccess", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetComputeAccessInput"}, + "output":{"shape":"GetComputeAccessOutput"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InvalidRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalServiceException"} + ] + }, + "GetComputeAuthToken":{ + "name":"GetComputeAuthToken", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetComputeAuthTokenInput"}, + "output":{"shape":"GetComputeAuthTokenOutput"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InvalidRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalServiceException"} + ] + }, "GetGameSessionLogUrl":{ "name":"GetGameSessionLogUrl", "http":{ @@ -964,6 +1059,20 @@ {"shape":"InternalServiceException"} ] }, + "ListCompute":{ + "name":"ListCompute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListComputeInput"}, + "output":{"shape":"ListComputeOutput"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InternalServiceException"} + ] + }, "ListFleets":{ "name":"ListFleets", "http":{ @@ -1007,6 +1116,20 @@ {"shape":"InternalServiceException"} ] }, + "ListLocations":{ + "name":"ListLocations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListLocationsInput"}, + "output":{"shape":"ListLocationsOutput"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InternalServiceException"} + ] + }, "ListScripts":{ "name":"ListScripts", "http":{ @@ -1051,6 +1174,21 @@ {"shape":"NotFoundException"} ] }, + "RegisterCompute":{ + "name":"RegisterCompute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterComputeInput"}, + "output":{"shape":"RegisterComputeOutput"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServiceException"} + ] + }, "RegisterGameServer":{ "name":"RegisterGameServer", "http":{ @@ -1063,8 +1201,8 @@ {"shape":"InvalidRequestException"}, {"shape":"ConflictException"}, {"shape":"UnauthorizedException"}, - {"shape":"InternalServiceException"}, - {"shape":"LimitExceededException"} + {"shape":"LimitExceededException"}, + {"shape":"InternalServiceException"} ] }, "RequestUploadCredentials":{ @@ -1549,6 +1687,13 @@ "max":1011, "min":1 }, + "AnywhereConfiguration":{ + "type":"structure", + "required":["Cost"], + "members":{ + "Cost":{"shape":"NonNegativeLimitedLengthDouble"} + } + }, "ArnStringModel":{ "type":"string", "max":256, @@ -1558,10 +1703,10 @@ "AttributeValue":{ "type":"structure", "members":{ - "S":{"shape":"NonZeroAndMaxString"}, + "S":{"shape":"PlayerAttributeString"}, "N":{"shape":"DoubleObject"}, - "SL":{"shape":"StringList"}, - "SDM":{"shape":"StringDoubleMap"} + "SL":{"shape":"PlayerAttributeStringList"}, + "SDM":{"shape":"PlayerAttributeStringDoubleMap"} } }, "AutoScalingGroupArn":{ @@ -1605,7 +1750,8 @@ "Status":{"shape":"BuildStatus"}, "SizeOnDisk":{"shape":"PositiveLong"}, "OperatingSystem":{"shape":"OperatingSystem"}, - "CreationTime":{"shape":"Timestamp"} + "CreationTime":{"shape":"Timestamp"}, + "ServerSdkVersion":{"shape":"ServerSdkVersion"} } }, "BuildArn":{ @@ -1670,6 +1816,64 @@ "LessThanOrEqualToThreshold" ] }, + "Compute":{ + "type":"structure", + "members":{ + "FleetId":{"shape":"FleetId"}, + "FleetArn":{"shape":"FleetArn"}, + "ComputeName":{"shape":"ComputeName"}, + "ComputeArn":{"shape":"ComputeArn"}, + "IpAddress":{"shape":"IpAddress"}, + "DnsName":{"shape":"DnsName"}, + "ComputeStatus":{"shape":"ComputeStatus"}, + "Location":{"shape":"LocationStringModel"}, + "CreationTime":{"shape":"Timestamp"}, + "OperatingSystem":{"shape":"OperatingSystem"}, + "Type":{"shape":"EC2InstanceType"}, + "GameLiftServiceSdkEndpoint":{"shape":"GameLiftServiceSdkEndpointOutput"} + } + }, + "ComputeArn":{ + "type":"string", + "max":1024, + "pattern":"^arn:.*:compute\\/[a-zA-Z0-9\\-]+" + }, + "ComputeAuthToken":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[a-zA-Z0-9\\-]+" + }, + "ComputeList":{ + "type":"list", + "member":{"shape":"Compute"} + }, + "ComputeName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[a-zA-Z0-9\\-]+" + }, + "ComputeNameOrArn":{ + "type":"string", + "max":1024, + "pattern":"[a-zA-Z0-9\\-]+|^arn:.*:compute\\/[a-zA-Z0-9\\-]+" + }, + "ComputeStatus":{ + "type":"string", + "enum":[ + "PENDING", + "ACTIVE", + "TERMINATING" + ] + }, + "ComputeType":{ + "type":"string", + "enum":[ + "EC2", + "ANYWHERE" + ] + }, "ConflictException":{ "type":"structure", "members":{ @@ -1703,7 +1907,8 @@ "Version":{"shape":"NonZeroAndMaxString"}, "StorageLocation":{"shape":"S3Location"}, "OperatingSystem":{"shape":"OperatingSystem"}, - "Tags":{"shape":"TagList"} + "Tags":{"shape":"TagList"}, + "ServerSdkVersion":{"shape":"ServerSdkVersion"} } }, "CreateBuildOutput":{ @@ -1716,10 +1921,7 @@ }, "CreateFleetInput":{ "type":"structure", - "required":[ - "Name", - "EC2InstanceType" - ], + "required":["Name"], "members":{ "Name":{"shape":"NonZeroAndMaxString"}, "Description":{"shape":"NonZeroAndMaxString"}, @@ -1740,7 +1942,9 @@ "InstanceRoleArn":{"shape":"NonEmptyString"}, "CertificateConfiguration":{"shape":"CertificateConfiguration"}, "Locations":{"shape":"LocationConfigurationList"}, - "Tags":{"shape":"TagList"} + "Tags":{"shape":"TagList"}, + "ComputeType":{"shape":"ComputeType"}, + "AnywhereConfiguration":{"shape":"AnywhereConfiguration"} } }, "CreateFleetLocationsInput":{ @@ -1842,6 +2046,20 @@ "GameSessionQueue":{"shape":"GameSessionQueue"} } }, + "CreateLocationInput":{ + "type":"structure", + "required":["LocationName"], + "members":{ + "LocationName":{"shape":"CustomInputLocationStringModel"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateLocationOutput":{ + "type":"structure", + "members":{ + "Location":{"shape":"LocationModel"} + } + }, "CreateMatchmakingConfigurationInput":{ "type":"structure", "required":[ @@ -1985,6 +2203,18 @@ "max":256, "min":0 }, + "CustomInputLocationStringModel":{ + "type":"string", + "max":64, + "min":8, + "pattern":"^custom-[A-Za-z0-9\\-]+" + }, + "CustomLocationNameOrArnModel":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^custom-[A-Za-z0-9\\-]+|^arn:.*:location\\/custom-\\S+" + }, "DeleteAliasInput":{ "type":"structure", "required":["AliasId"], @@ -2051,6 +2281,18 @@ "members":{ } }, + "DeleteLocationInput":{ + "type":"structure", + "required":["LocationName"], + "members":{ + "LocationName":{"shape":"CustomLocationNameOrArnModel"} + } + }, + "DeleteLocationOutput":{ + "type":"structure", + "members":{ + } + }, "DeleteMatchmakingConfigurationInput":{ "type":"structure", "required":["Name"], @@ -2125,6 +2367,22 @@ "members":{ } }, + "DeregisterComputeInput":{ + "type":"structure", + "required":[ + "FleetId", + "ComputeName" + ], + "members":{ + "FleetId":{"shape":"FleetIdOrArn"}, + "ComputeName":{"shape":"ComputeNameOrArn"} + } + }, + "DeregisterComputeOutput":{ + "type":"structure", + "members":{ + } + }, "DeregisterGameServerInput":{ "type":"structure", "required":[ @@ -2162,6 +2420,23 @@ "Build":{"shape":"Build"} } }, + "DescribeComputeInput":{ + "type":"structure", + "required":[ + "FleetId", + "ComputeName" + ], + "members":{ + "FleetId":{"shape":"FleetIdOrArn"}, + "ComputeName":{"shape":"ComputeNameOrArn"} + } + }, + "DescribeComputeOutput":{ + "type":"structure", + "members":{ + "Compute":{"shape":"Compute"} + } + }, "DescribeEC2InstanceLimitsInput":{ "type":"structure", "members":{ @@ -2582,6 +2857,12 @@ "member":{"shape":"DesiredPlayerSession"} }, "DnsName":{"type":"string"}, + "DnsNameInput":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^[0-9a-zA-Z_\\-\\.]+" + }, "Double":{"type":"double"}, "DoubleObject":{"type":"double"}, "EC2InstanceCounts":{ @@ -2774,7 +3055,8 @@ "FLEET_VPC_PEERING_SUCCEEDED", "FLEET_VPC_PEERING_FAILED", "FLEET_VPC_PEERING_DELETED", - "INSTANCE_INTERRUPTED" + "INSTANCE_INTERRUPTED", + "INSTANCE_RECYCLED" ] }, "EventList":{ @@ -2826,7 +3108,9 @@ "MetricGroups":{"shape":"MetricGroupList"}, "StoppedActions":{"shape":"FleetActionList"}, "InstanceRoleArn":{"shape":"NonEmptyString"}, - "CertificateConfiguration":{"shape":"CertificateConfiguration"} + "CertificateConfiguration":{"shape":"CertificateConfiguration"}, + "ComputeType":{"shape":"ComputeType"}, + "AnywhereConfiguration":{"shape":"AnywhereConfiguration"} } }, "FleetAttributesList":{ @@ -2883,7 +3167,8 @@ "ACTIVE", "DELETING", "ERROR", - "TERMINATED" + "TERMINATED", + "NOT_FOUND" ] }, "FleetType":{ @@ -2918,6 +3203,11 @@ }, "Float":{"type":"float"}, "FreeText":{"type":"string"}, + "GameLiftServiceSdkEndpointOutput":{ + "type":"string", + "max":128, + "min":1 + }, "GameProperty":{ "type":"structure", "required":[ @@ -3238,7 +3528,7 @@ "type":"structure", "members":{ "GameSessionArn":{"shape":"ArnStringModel"}, - "IpAddress":{"shape":"StringModel"}, + "IpAddress":{"shape":"IpAddress"}, "DnsName":{"shape":"DnsName"}, "Port":{"shape":"PositiveInteger"}, "MatchedPlayerSessions":{"shape":"MatchedPlayerSessionList"} @@ -3368,6 +3658,49 @@ "type":"string", "enum":["INTERRUPTED"] }, + "GetComputeAccessInput":{ + "type":"structure", + "required":[ + "FleetId", + "ComputeName" + ], + "members":{ + "FleetId":{"shape":"FleetIdOrArn"}, + "ComputeName":{"shape":"ComputeNameOrArn"} + } + }, + "GetComputeAccessOutput":{ + "type":"structure", + "members":{ + "FleetId":{"shape":"FleetIdOrArn"}, + "FleetArn":{"shape":"FleetArn"}, + "ComputeName":{"shape":"ComputeNameOrArn"}, + "ComputeArn":{"shape":"ComputeArn"}, + "Credentials":{"shape":"AwsCredentials"} + } + }, + "GetComputeAuthTokenInput":{ + "type":"structure", + "required":[ + "FleetId", + "ComputeName" + ], + "members":{ + "FleetId":{"shape":"FleetIdOrArn"}, + "ComputeName":{"shape":"ComputeNameOrArn"} + } + }, + "GetComputeAuthTokenOutput":{ + "type":"structure", + "members":{ + "FleetId":{"shape":"FleetIdOrArn"}, + "FleetArn":{"shape":"FleetArn"}, + "ComputeName":{"shape":"ComputeNameOrArn"}, + "ComputeArn":{"shape":"ComputeArn"}, + "AuthToken":{"shape":"ComputeAuthToken"}, + "ExpirationTimestamp":{"shape":"Timestamp"} + } + }, "GetGameSessionLogUrlInput":{ "type":"structure", "required":["GameSessionId"], @@ -3514,7 +3847,7 @@ "type":"string", "max":128, "min":1, - "pattern":"^(?:[0-9]{1,3}\\.){3}[0-9]{1,3}$" + "pattern":"^[0-9A-Fa-f\\:\\.]+" }, "IpPermission":{ "type":"structure", @@ -3629,6 +3962,23 @@ "NextToken":{"shape":"NonEmptyString"} } }, + "ListComputeInput":{ + "type":"structure", + "required":["FleetId"], + "members":{ + "FleetId":{"shape":"FleetIdOrArn"}, + "Location":{"shape":"LocationStringModel"}, + "Limit":{"shape":"PositiveInteger"}, + "NextToken":{"shape":"NonZeroAndMaxString"} + } + }, + "ListComputeOutput":{ + "type":"structure", + "members":{ + "ComputeList":{"shape":"ComputeList"}, + "NextToken":{"shape":"NonZeroAndMaxString"} + } + }, "ListFleetsInput":{ "type":"structure", "members":{ @@ -3676,6 +4026,26 @@ "NextToken":{"shape":"NonZeroAndMaxString"} } }, + "ListLocationsInput":{ + "type":"structure", + "members":{ + "Filters":{"shape":"LocationFilterList"}, + "Limit":{"shape":"ListLocationsLimit"}, + "NextToken":{"shape":"NonZeroAndMaxString"} + } + }, + "ListLocationsLimit":{ + "type":"integer", + "max":200, + "min":1 + }, + "ListLocationsOutput":{ + "type":"structure", + "members":{ + "Locations":{"shape":"LocationModelList"}, + "NextToken":{"shape":"NonZeroAndMaxString"} + } + }, "ListScriptsInput":{ "type":"structure", "members":{ @@ -3703,6 +4073,12 @@ "Tags":{"shape":"TagList"} } }, + "LocationArnModel":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^arn:.*:location\\/custom-\\S+" + }, "LocationAttributes":{ "type":"structure", "members":{ @@ -3717,6 +4093,7 @@ }, "LocationConfiguration":{ "type":"structure", + "required":["Location"], "members":{ "Location":{"shape":"LocationStringModel"} } @@ -3727,12 +4104,36 @@ "max":100, "min":1 }, + "LocationFilter":{ + "type":"string", + "enum":[ + "AWS", + "CUSTOM" + ] + }, + "LocationFilterList":{ + "type":"list", + "member":{"shape":"LocationFilter"}, + "max":2, + "min":1 + }, "LocationList":{ "type":"list", "member":{"shape":"LocationStringModel"}, "max":100, "min":1 }, + "LocationModel":{ + "type":"structure", + "members":{ + "LocationName":{"shape":"LocationStringModel"}, + "LocationArn":{"shape":"LocationArnModel"} + } + }, + "LocationModelList":{ + "type":"list", + "member":{"shape":"LocationModel"} + }, "LocationState":{ "type":"structure", "members":{ @@ -3748,7 +4149,7 @@ "type":"string", "max":64, "min":1, - "pattern":"^[a-z]+(-([a-z]+|\\d))*" + "pattern":"^[A-Za-z0-9\\-]+" }, "LocationUpdateStatus":{ "type":"string", @@ -3920,7 +4321,8 @@ "PercentAvailableGameSessions", "PercentIdleInstances", "QueueDepth", - "WaitTime" + "WaitTime", + "ConcurrentActivatableGameSessions" ] }, "NonBlankAndLengthConstraintString":{ @@ -3941,6 +4343,12 @@ "type":"double", "min":0 }, + "NonNegativeLimitedLengthDouble":{ + "type":"string", + "max":11, + "min":1, + "pattern":"^\\d{1,5}(?:\\.\\d{1,5})?$" + }, "NonZeroAndMaxString":{ "type":"string", "max":1024, @@ -3993,6 +4401,20 @@ "key":{"shape":"NonZeroAndMaxString"}, "value":{"shape":"AttributeValue"} }, + "PlayerAttributeString":{ + "type":"string", + "max":100, + "min":1 + }, + "PlayerAttributeStringDoubleMap":{ + "type":"map", + "key":{"shape":"PlayerAttributeString"}, + "value":{"shape":"DoubleObject"} + }, + "PlayerAttributeStringList":{ + "type":"list", + "member":{"shape":"PlayerAttributeString"} + }, "PlayerData":{ "type":"string", "max":2048, @@ -4168,6 +4590,27 @@ "min":0, "pattern":"[a-zA-Z0-9:_-]*(\\.fifo)?" }, + "RegisterComputeInput":{ + "type":"structure", + "required":[ + "FleetId", + "ComputeName" + ], + "members":{ + "FleetId":{"shape":"FleetIdOrArn"}, + "ComputeName":{"shape":"ComputeName"}, + "CertificatePath":{"shape":"NonZeroAndMaxString"}, + "DnsName":{"shape":"DnsNameInput"}, + "IpAddress":{"shape":"IpAddress"}, + "Location":{"shape":"LocationStringModel"} + } + }, + "RegisterComputeOutput":{ + "type":"structure", + "members":{ + "Compute":{"shape":"Compute"} + } + }, "RegisterGameServerInput":{ "type":"structure", "required":[ @@ -4391,6 +4834,11 @@ "max":50, "min":1 }, + "ServerSdkVersion":{ + "type":"string", + "max":128, + "pattern":"^\\d+\\.\\d+\\.\\d+$" + }, "SnsArnStringModel":{ "type":"string", "max":300, @@ -4528,11 +4976,6 @@ "members":{ } }, - "StringDoubleMap":{ - "type":"map", - "key":{"shape":"NonZeroAndMaxString"}, - "value":{"shape":"DoubleObject"} - }, "StringList":{ "type":"list", "member":{"shape":"NonZeroAndMaxString"} @@ -4703,13 +5146,15 @@ "Description":{"shape":"NonZeroAndMaxString"}, "NewGameSessionProtectionPolicy":{"shape":"ProtectionPolicy"}, "ResourceCreationLimitPolicy":{"shape":"ResourceCreationLimitPolicy"}, - "MetricGroups":{"shape":"MetricGroupList"} + "MetricGroups":{"shape":"MetricGroupList"}, + "AnywhereConfiguration":{"shape":"AnywhereConfiguration"} } }, "UpdateFleetAttributesOutput":{ "type":"structure", "members":{ - "FleetId":{"shape":"FleetId"} + "FleetId":{"shape":"FleetId"}, + "FleetArn":{"shape":"FleetArn"} } }, "UpdateFleetCapacityInput":{ @@ -4743,7 +5188,8 @@ "UpdateFleetPortSettingsOutput":{ "type":"structure", "members":{ - "FleetId":{"shape":"FleetId"} + "FleetId":{"shape":"FleetId"}, + "FleetArn":{"shape":"FleetArn"} } }, "UpdateGameServerGroupInput":{ diff --git a/models/apis/gamelift/2015-10-01/docs-2.json b/models/apis/gamelift/2015-10-01/docs-2.json index e7bb74dfaae..82841d5f0ab 100644 --- a/models/apis/gamelift/2015-10-01/docs-2.json +++ b/models/apis/gamelift/2015-10-01/docs-2.json @@ -1,106 +1,115 @@ { "version": "2.0", - "service": "Amazon Web Services provides solutions for hosting session-based multiplayer game servers in the cloud, including tools for deploying, operating, and scaling game servers. Built on Amazon Web Services global computing infrastructure, GameLift helps you deliver high-performance, high-reliability, low-cost game servers while dynamically scaling your resource usage to meet player demand.
About GameLift solutions
Get more information on these GameLift solutions in the GameLift Developer Guide.
GameLift managed hosting -- GameLift offers a fully managed service to set up and maintain computing machines for hosting, manage game session and player session life cycle, and handle security, storage, and performance tracking. You can use automatic scaling tools to balance player demand and hosting costs, configure your game session management to minimize player latency, and add FlexMatch for matchmaking.
Managed hosting with Realtime Servers -- With GameLift Realtime Servers, you can quickly configure and set up ready-to-go game servers for your game. Realtime Servers provides a game server framework with core GameLift infrastructure already built in. Then use the full range of GameLift managed hosting features, including FlexMatch, for your game.
GameLift FleetIQ -- Use GameLift FleetIQ as a standalone service while hosting your games using EC2 instances and Auto Scaling groups. GameLift FleetIQ provides optimizations for game hosting, including boosting the viability of low-cost Spot Instances gaming. For a complete solution, pair the GameLift FleetIQ and FlexMatch standalone services.
GameLift FlexMatch -- Add matchmaking to your game hosting solution. FlexMatch is a customizable matchmaking service for multiplayer games. Use FlexMatch as integrated with GameLift managed hosting or incorporate FlexMatch as a standalone service into your own hosting solution.
About this API Reference
This reference guide describes the low-level service API for Amazon Web Services. With each topic in this guide, you can find links to language-specific SDK guides and the Amazon Web Services CLI reference. Useful links:
", + "service": "Amazon GameLift provides solutions for hosting session-based multiplayer game servers in the cloud, including tools for deploying, operating, and scaling game servers. Built on Amazon Web Services global computing infrastructure, GameLift helps you deliver high-performance, high-reliability, low-cost game servers while dynamically scaling your resource usage to meet player demand.
About GameLift solutions
Get more information on these GameLift solutions in the GameLift Developer Guide.
GameLift managed hosting -- GameLift offers a fully managed service to set up and maintain computing machines for hosting, manage game session and player session life cycle, and handle security, storage, and performance tracking. You can use automatic scaling tools to balance player demand and hosting costs, configure your game session management to minimize player latency, and add FlexMatch for matchmaking.
Managed hosting with Realtime Servers -- With GameLift Realtime Servers, you can quickly configure and set up ready-to-go game servers for your game. Realtime Servers provides a game server framework with core GameLift infrastructure already built in. Then use the full range of GameLift managed hosting features, including FlexMatch, for your game.
GameLift FleetIQ -- Use GameLift FleetIQ as a standalone service while hosting your games using EC2 instances and Auto Scaling groups. GameLift FleetIQ provides optimizations for game hosting, including boosting the viability of low-cost Spot Instances gaming. For a complete solution, pair the GameLift FleetIQ and FlexMatch standalone services.
GameLift FlexMatch -- Add matchmaking to your game hosting solution. FlexMatch is a customizable matchmaking service for multiplayer games. Use FlexMatch as integrated with GameLift managed hosting or incorporate FlexMatch as a standalone service into your own hosting solution.
About this API Reference
This reference guide describes the low-level service API for Amazon GameLift. With each topic in this guide, you can find links to language-specific SDK guides and the Amazon Web Services CLI reference. Useful links:
", "operations": { - "AcceptMatch": "Registers a player's acceptance or rejection of a proposed FlexMatch match. A matchmaking configuration may require player acceptance; if so, then matches built with that configuration cannot be completed unless all players accept the proposed match within a specified time limit.
When FlexMatch builds a match, all the matchmaking tickets involved in the proposed match are placed into status REQUIRES_ACCEPTANCE. This is a trigger for your game to get acceptance from all players in the ticket. Acceptances are only valid for tickets when they are in this status; all other acceptances result in an error.
To register acceptance, specify the ticket ID, a response, and one or more players. Once all players have registered acceptance, the matchmaking tickets advance to status PLACING, where a new game session is created for the match.
If any player rejects the match, or if acceptances are not received before a specified timeout, the proposed match is dropped. The matchmaking tickets are then handled in one of two ways: For tickets where one or more players rejected the match or failed to respond, the ticket status is set to CANCELLED, and processing is terminated. For tickets where players have accepted or not yet responded, the ticket status is returned to SEARCHING to find a new match. A new matchmaking request for these players can be submitted as needed.
Learn more
Add FlexMatch to a game client
FlexMatch events (reference)
Related actions
StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch | StartMatchBackfill | All APIs by task
", - "ClaimGameServer": "This operation is used with the GameLift FleetIQ solution and game server groups.
Locates an available game server and temporarily reserves it to host gameplay and players. This operation is called from a game client or client service (such as a matchmaker) to request hosting resources for a new game session. In response, GameLift FleetIQ locates an available game server, places it in CLAIMED status for 60 seconds, and returns connection information that players can use to connect to the game server.
To claim a game server, identify a game server group. You can also specify a game server ID, although this approach bypasses GameLift FleetIQ placement optimization. Optionally, include game data to pass to the game server at the start of a game session, such as a game map or player information.
When a game server is successfully claimed, connection information is returned. A claimed game server's utilization status remains AVAILABLE while the claim status is set to CLAIMED for up to 60 seconds. This time period gives the game server time to update its status to UTILIZED (using UpdateGameServer) once players join. If the game server's status is not updated within 60 seconds, the game server reverts to unclaimed status and is available to be claimed by another request. The claim time period is a fixed value and is not configurable.
If you try to claim a specific game server, this request will fail in the following cases:
If the game server utilization status is UTILIZED.
If the game server claim status is CLAIMED.
When claiming a specific game server, this request will succeed even if the game server is running on an instance in DRAINING status. To avoid this, first check the instance status by calling DescribeGameServerInstances.
Learn more
Related actions
RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer | UpdateGameServer | DeregisterGameServer | All APIs by task
", - "CreateAlias": "Creates an alias for a fleet. In most situations, you can use an alias ID in place of a fleet ID. An alias provides a level of abstraction for a fleet that is useful when redirecting player traffic from one fleet to another, such as when updating your game build.
Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias is used to display messaging or link to a URL instead of routing players to an active fleet. For example, you might use a terminal alias when a game version is no longer supported and you want to direct players to an upgrade site.
To create a fleet alias, specify an alias name, routing strategy, and optional description. Each simple alias can point to only one fleet, but a fleet can have multiple aliases. If successful, a new alias record is returned, including an alias ID and an ARN. You can reassign an alias to another fleet by calling UpdateAlias.
Related actions
CreateAlias | ListAliases | DescribeAlias | UpdateAlias | DeleteAlias | ResolveAlias | All APIs by task
", - "CreateBuild": "Creates a new Amazon GameLift build resource for your game server binary files. Game server binaries must be combined into a zip file for use with Amazon GameLift.
When setting up a new game build for GameLift, we recommend using the Amazon Web Services CLI command upload-build . This helper command combines two tasks: (1) it uploads your build files from a file directory to a GameLift Amazon S3 location, and (2) it creates a new build resource.
The CreateBuild operation can used in the following scenarios:
To create a new game build with build files that are in an Amazon S3 location under an Amazon Web Services account that you control. To use this option, you must first give Amazon GameLift access to the Amazon S3 bucket. With permissions in place, call CreateBuild and specify a build name, operating system, and the Amazon S3 storage location of your game build.
To directly upload your build files to a GameLift Amazon S3 location. To use this option, first call CreateBuild and specify a build name and operating system. This operation creates a new build resource and also returns an Amazon S3 location with temporary access credentials. Use the credentials to manually upload your build files to the specified Amazon S3 location. For more information, see Uploading Objects in the Amazon S3 Developer Guide. Build files can be uploaded to the GameLift Amazon S3 location once only; that can't be updated.
If successful, this operation creates a new build resource with a unique build ID and places it in INITIALIZED status. A build must be in READY status before you can create fleets with it.
Learn more
Create a Build with Files in Amazon S3
Related actions
CreateBuild | ListBuilds | DescribeBuild | UpdateBuild | DeleteBuild | All APIs by task
", - "CreateFleet": "Creates a fleet of Amazon Elastic Compute Cloud (Amazon Elastic Compute Cloud) instances to host your custom game server or Realtime Servers. Use this operation to configure the computing resources for your fleet and provide instructions for running game servers on each instance.
Most GameLift fleets can deploy instances to multiple locations, including the home Region (where the fleet is created) and an optional set of remote locations. Fleets that are created in the following Amazon Web Services Regions support multiple locations: us-east-1 (N. Virginia), us-west-2 (Oregon), eu-central-1 (Frankfurt), eu-west-1 (Ireland), ap-southeast-2 (Sydney), ap-northeast-1 (Tokyo), and ap-northeast-2 (Seoul). Fleets that are created in other GameLift Regions can deploy instances in the fleet's home Region only. All fleet instances use the same configuration regardless of location; however, you can adjust capacity settings and turn auto-scaling on/off for each location.
To create a fleet, choose the hardware for your instances, specify a game server build or Realtime script to deploy, and provide a runtime configuration to direct GameLift how to start and run game servers on each instance in the fleet. Set permissions for inbound traffic to your game servers, and enable optional features as needed. When creating a multi-location fleet, provide a list of additional remote locations.
If you need to debug your fleet, fetch logs, view performance metrics or other actions on the fleet, create the development fleet with port 22/3389 open. As a best practice, we recommend opening ports for remote access only when you need them and closing them when you're finished.
If successful, this operation creates a new Fleet resource and places it in NEW status, which prompts GameLift to initiate the fleet creation workflow. You can track fleet creation by checking fleet status using DescribeFleetAttributes and DescribeFleetLocationAttributes/, or by monitoring fleet creation events using DescribeFleetEvents. As soon as the fleet status changes to ACTIVE, you can enable automatic scaling for the fleet with PutScalingPolicy and set capacity for the home Region with UpdateFleetCapacity. When the status of each remote location reaches ACTIVE, you can set capacity by location using UpdateFleetCapacity.
Learn more
Related actions
CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes | StopFleetActions | DeleteFleet | All APIs by task
", - "CreateFleetLocations": "Adds remote locations to a fleet and begins populating the new locations with EC2 instances. The new instances conform to the fleet's instance type, auto-scaling, and other configuration settings.
This operation cannot be used with fleets that don't support remote locations. Fleets can have multiple locations only if they reside in Amazon Web Services Regions that support this feature (see CreateFleet for the complete list) and were created after the feature was released in March 2021.
To add fleet locations, specify the fleet to be updated and provide a list of one or more locations.
If successful, this operation returns the list of added locations with their status set to NEW. GameLift initiates the process of starting an instance in each added location. You can track the status of each new location by monitoring location creation events using DescribeFleetEvents. Alternatively, you can poll location status by calling DescribeFleetLocationAttributes. After a location status becomes ACTIVE, you can adjust the location's capacity as needed with UpdateFleetCapacity.
Learn more
Related actions
CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions | DeleteFleetLocations | All APIs by task
", - "CreateGameServerGroup": "This operation is used with the GameLift FleetIQ solution and game server groups.
Creates a GameLift FleetIQ game server group for managing game hosting on a collection of Amazon Elastic Compute Cloud instances for game hosting. This operation creates the game server group, creates an Auto Scaling group in your Amazon Web Services account, and establishes a link between the two groups. You can view the status of your game server groups in the GameLift console. Game server group metrics and events are emitted to Amazon CloudWatch.
Before creating a new game server group, you must have the following:
An Amazon Elastic Compute Cloud launch template that specifies how to launch Amazon Elastic Compute Cloud instances with your game server build. For more information, see Launching an Instance from a Launch Template in the Amazon Elastic Compute Cloud User Guide.
An IAM role that extends limited access to your Amazon Web Services account to allow GameLift FleetIQ to create and interact with the Auto Scaling group. For more information, see Create IAM roles for cross-service interaction in the GameLift FleetIQ Developer Guide.
To create a new game server group, specify a unique group name, IAM role and Amazon Elastic Compute Cloud launch template, and provide a list of instance types that can be used in the group. You must also set initial maximum and minimum limits on the group's instance count. You can optionally set an Auto Scaling policy with target tracking based on a GameLift FleetIQ metric.
Once the game server group and corresponding Auto Scaling group are created, you have full access to change the Auto Scaling group's configuration as needed. Several properties that are set when creating a game server group, including maximum/minimum size and auto-scaling policy settings, must be updated directly in the Auto Scaling group. Keep in mind that some Auto Scaling group properties are periodically updated by GameLift FleetIQ as part of its balancing activities to optimize for availability and cost.
Learn more
Related actions
CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup | SuspendGameServerGroup | DescribeGameServerInstances | All APIs by task
", - "CreateGameSession": "Creates a multiplayer game session for players in a specific fleet location. This operation prompts an available server process to start a game session and retrieves connection information for the new game session. As an alternative, consider using the GameLift game session placement feature with
with StartGameSessionPlacement, which uses FleetIQ algorithms and queues to optimize the placement process.
When creating a game session, you specify exactly where you want to place it and provide a set of game session configuration settings. The fleet must be in ACTIVE status before a game session can be created in it.
This operation can be used in the following ways:
To create a game session on an instance in a fleet's home Region, provide a fleet or alias ID along with your game session configuration.
To create a game session on an instance in a fleet's remote location, provide a fleet or alias ID and a location name, along with your game session configuration.
If successful, a workflow is initiated to start a new game session. A GameSession object is returned containing the game session configuration and status. When the status is ACTIVE, game session connection information is provided and player sessions can be created for the game session. By default, newly created game sessions are open to new players. You can restrict new player access by using UpdateGameSession to change the game session's player session creation policy.
Game session logs are retained for all active game sessions for 14 days. To access the logs, call GetGameSessionLogUrl to download the log files.
Available in Amazon GameLift Local.
Learn more
Related actions
CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task
", + "AcceptMatch": "Registers a player's acceptance or rejection of a proposed FlexMatch match. A matchmaking configuration may require player acceptance; if so, then matches built with that configuration cannot be completed unless all players accept the proposed match within a specified time limit.
When FlexMatch builds a match, all the matchmaking tickets involved in the proposed match are placed into status REQUIRES_ACCEPTANCE. This is a trigger for your game to get acceptance from all players in the ticket. Acceptances are only valid for tickets when they are in this status; all other acceptances result in an error.
To register acceptance, specify the ticket ID, a response, and one or more players. Once all players have registered acceptance, the matchmaking tickets advance to status PLACING, where a new game session is created for the match.
If any player rejects the match, or if acceptances are not received before a specified timeout, the proposed match is dropped. The matchmaking tickets are then handled in one of two ways: For tickets where one or more players rejected the match or failed to respond, the ticket status is set to CANCELLED, and processing is terminated. For tickets where players have accepted or not yet responded, the ticket status is returned to SEARCHING to find a new match. A new matchmaking request for these players can be submitted as needed.
Learn more
Add FlexMatch to a game client
FlexMatch events (reference)
", + "ClaimGameServer": "This operation is used with the GameLift FleetIQ solution and game server groups.
Locates an available game server and temporarily reserves it to host gameplay and players. This operation is called from a game client or client service (such as a matchmaker) to request hosting resources for a new game session. In response, GameLift FleetIQ locates an available game server, places it in CLAIMED status for 60 seconds, and returns connection information that players can use to connect to the game server.
To claim a game server, identify a game server group. You can also specify a game server ID, although this approach bypasses GameLift FleetIQ placement optimization. Optionally, include game data to pass to the game server at the start of a game session, such as a game map or player information.
When a game server is successfully claimed, connection information is returned. A claimed game server's utilization status remains AVAILABLE while the claim status is set to CLAIMED for up to 60 seconds. This time period gives the game server time to update its status to UTILIZED after players join. If the game server's status is not updated within 60 seconds, the game server reverts to unclaimed status and is available to be claimed by another request. The claim time period is a fixed value and is not configurable.
If you try to claim a specific game server, this request will fail in the following cases:
If the game server utilization status is UTILIZED.
If the game server claim status is CLAIMED.
When claiming a specific game server, this request will succeed even if the game server is running on an instance in DRAINING status. To avoid this, first check the instance status by calling DescribeGameServerInstances .
Learn more
", + "CreateAlias": "Creates an alias for a fleet. In most situations, you can use an alias ID in place of a fleet ID. An alias provides a level of abstraction for a fleet that is useful when redirecting player traffic from one fleet to another, such as when updating your game build.
Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias is used to display messaging or link to a URL instead of routing players to an active fleet. For example, you might use a terminal alias when a game version is no longer supported and you want to direct players to an upgrade site.
To create a fleet alias, specify an alias name, routing strategy, and optional description. Each simple alias can point to only one fleet, but a fleet can have multiple aliases. If successful, a new alias record is returned, including an alias ID and an ARN. You can reassign an alias to another fleet by calling UpdateAlias.
Related actions
", + "CreateBuild": "Creates a new Amazon GameLift build resource for your game server binary files. Combine game server binaries into a zip file for use with Amazon GameLift.
When setting up a new game build for GameLift, we recommend using the CLI command upload-build . This helper command combines two tasks: (1) it uploads your build files from a file directory to a GameLift Amazon S3 location, and (2) it creates a new build resource.
You can use the operation in the following scenarios:
To create a new game build with build files that are in an Amazon S3 location under an Amazon Web Services account that you control. To use this option, you give Amazon GameLift access to the Amazon S3 bucket. With permissions in place, specify a build name, operating system, and the Amazon S3 storage location of your game build.
To directly upload your build files to a GameLift Amazon S3 location. To use this option, specify a build name and operating system. This operation creates a new build resource and also returns an Amazon S3 location with temporary access credentials. Use the credentials to manually upload your build files to the specified Amazon S3 location. For more information, see Uploading Objects in the Amazon S3 Developer Guide. After you upload build files to the GameLift Amazon S3 location, you can't update them.
If successful, this operation creates a new build resource with a unique build ID and places it in INITIALIZED status. A build must be in READY status before you can create fleets with it.
Learn more
Create a Build with Files in Amazon S3
", + "CreateFleet": "Creates a fleet of Amazon Elastic Compute Cloud (Amazon Elastic Compute Cloud) instances to host your custom game server or Realtime Servers. Use this operation to configure the computing resources for your fleet and provide instructions for running game servers on each instance.
Most GameLift fleets can deploy instances to multiple locations, including the home Region (where the fleet is created) and an optional set of remote locations. Fleets that are created in the following Amazon Web Services Regions support multiple locations: us-east-1 (N. Virginia), us-west-2 (Oregon), eu-central-1 (Frankfurt), eu-west-1 (Ireland), ap-southeast-2 (Sydney), ap-northeast-1 (Tokyo), and ap-northeast-2 (Seoul). Fleets that are created in other GameLift Regions can deploy instances in the fleet's home Region only. All fleet instances use the same configuration regardless of location; however, you can adjust capacity settings and turn auto-scaling on/off for each location.
To create a fleet, choose the hardware for your instances, specify a game server build or Realtime script to deploy, and provide a runtime configuration to direct GameLift how to start and run game servers on each instance in the fleet. Set permissions for inbound traffic to your game servers, and enable optional features as needed. When creating a multi-location fleet, provide a list of additional remote locations.
If you need to debug your fleet, fetch logs, view performance metrics or other actions on the fleet, create the development fleet with port 22/3389 open. As a best practice, we recommend opening ports for remote access only when you need them and closing them when you're finished.
If successful, this operation creates a new Fleet resource and places it in NEW status, which prompts GameLift to initiate the fleet creation workflow.
Learn more
", + "CreateFleetLocations": "Adds remote locations to a fleet and begins populating the new locations with EC2 instances. The new instances conform to the fleet's instance type, auto-scaling, and other configuration settings.
This operation cannot be used with fleets that don't support remote locations. Fleets can have multiple locations only if they reside in Amazon Web Services Regions that support this feature and were created after the feature was released in March 2021.
To add fleet locations, specify the fleet to be updated and provide a list of one or more locations.
If successful, this operation returns the list of added locations with their status set to NEW. GameLift initiates the process of starting an instance in each added location. You can track the status of each new location by monitoring location creation events using DescribeFleetEvents.
Learn more
", + "CreateGameServerGroup": "This operation is used with the GameLift FleetIQ solution and game server groups.
Creates a GameLift FleetIQ game server group for managing game hosting on a collection of Amazon Elastic Compute Cloud instances for game hosting. This operation creates the game server group, creates an Auto Scaling group in your Amazon Web Services account, and establishes a link between the two groups. You can view the status of your game server groups in the GameLift console. Game server group metrics and events are emitted to Amazon CloudWatch.
Before creating a new game server group, you must have the following:
An Amazon Elastic Compute Cloud launch template that specifies how to launch Amazon Elastic Compute Cloud instances with your game server build. For more information, see Launching an Instance from a Launch Template in the Amazon Elastic Compute Cloud User Guide.
An IAM role that extends limited access to your Amazon Web Services account to allow GameLift FleetIQ to create and interact with the Auto Scaling group. For more information, see Create IAM roles for cross-service interaction in the GameLift FleetIQ Developer Guide.
To create a new game server group, specify a unique group name, IAM role and Amazon Elastic Compute Cloud launch template, and provide a list of instance types that can be used in the group. You must also set initial maximum and minimum limits on the group's instance count. You can optionally set an Auto Scaling policy with target tracking based on a GameLift FleetIQ metric.
Once the game server group and corresponding Auto Scaling group are created, you have full access to change the Auto Scaling group's configuration as needed. Several properties that are set when creating a game server group, including maximum/minimum size and auto-scaling policy settings, must be updated directly in the Auto Scaling group. Keep in mind that some Auto Scaling group properties are periodically updated by GameLift FleetIQ as part of its balancing activities to optimize for availability and cost.
Learn more
", + "CreateGameSession": "Creates a multiplayer game session for players in a specific fleet location. This operation prompts an available server process to start a game session and retrieves connection information for the new game session. As an alternative, consider using the GameLift game session placement feature with StartGameSessionPlacement , which uses FleetIQ algorithms and queues to optimize the placement process.
When creating a game session, you specify exactly where you want to place it and provide a set of game session configuration settings. The fleet must be in ACTIVE status before a game session can be created in it.
This operation can be used in the following ways:
To create a game session on an instance in a fleet's home Region, provide a fleet or alias ID along with your game session configuration.
To create a game session on an instance in a fleet's remote location, provide a fleet or alias ID and a location name, along with your game session configuration.
If successful, a workflow is initiated to start a new game session. A GameSession object is returned containing the game session configuration and status. When the status is ACTIVE, game session connection information is provided and player sessions can be created for the game session. By default, newly created game sessions are open to new players. You can restrict new player access by using UpdateGameSession to change the game session's player session creation policy.
Game session logs are retained for all active game sessions for 14 days. To access the logs, call GetGameSessionLogUrl to download the log files.
Available in Amazon GameLift Local.
Learn more
", "CreateGameSessionQueue": "Creates a placement queue that processes requests for new game sessions. A queue uses FleetIQ algorithms to determine the best placement locations and find an available game server there, then prompts the game server process to start a new game session.
A game session queue is configured with a set of destinations (GameLift fleets or aliases), which determine the locations where the queue can place new game sessions. These destinations can span multiple fleet types (Spot and On-Demand), instance types, and Amazon Web Services Regions. If the queue includes multi-location fleets, the queue is able to place game sessions in all of a fleet's remote locations. You can opt to filter out individual locations if needed.
The queue configuration also determines how FleetIQ selects the best available placement for a new game session. Before searching for an available game server, FleetIQ first prioritizes the queue's destinations and locations, with the best placement locations on top. You can set up the queue to use the FleetIQ default prioritization or provide an alternate set of priorities.
To create a new queue, provide a name, timeout value, and a list of destinations. Optionally, specify a sort configuration and/or a filter, and define a set of latency cap policies. You can also include the ARN for an Amazon Simple Notification Service (SNS) topic to receive notifications of game session placement activity. Notifications using SNS or CloudWatch events is the preferred way to track placement activity.
If successful, a new GameSessionQueue object is returned with an assigned queue ARN. New game session requests, which are submitted to queue with StartGameSessionPlacement or StartMatchmaking, reference a queue's name or ARN.
Learn more
Related actions
CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue | DeleteGameSessionQueue | All APIs by task
", - "CreateMatchmakingConfiguration": "Defines a new matchmaking configuration for use with FlexMatch. Whether your are using FlexMatch with GameLift hosting or as a standalone matchmaking service, the matchmaking configuration sets out rules for matching players and forming teams. If you're also using GameLift hosting, it defines how to start game sessions for each match. Your matchmaking system can use multiple configurations to handle different game scenarios. All matchmaking requests (StartMatchmaking or StartMatchBackfill) identify the matchmaking configuration to use and provide player attributes consistent with that configuration.
To create a matchmaking configuration, you must provide the following: configuration name and FlexMatch mode (with or without GameLift hosting); a rule set that specifies how to evaluate players and find acceptable matches; whether player acceptance is required; and the maximum time allowed for a matchmaking attempt. When using FlexMatch with GameLift hosting, you also need to identify the game session queue to use when starting a game session for the match.
In addition, you must set up an Amazon Simple Notification Service topic to receive matchmaking notifications. Provide the topic ARN in the matchmaking configuration. An alternative method, continuously polling ticket status with DescribeMatchmaking, is only suitable for games in development with low matchmaking usage.
Learn more
Set up FlexMatch event notification
Related actions
CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet | DeleteMatchmakingRuleSet | All APIs by task
", - "CreateMatchmakingRuleSet": "Creates a new rule set for FlexMatch matchmaking. A rule set describes the type of match to create, such as the number and size of teams. It also sets the parameters for acceptable player matches, such as minimum skill level or character type. A rule set is used by a MatchmakingConfiguration.
To create a matchmaking rule set, provide unique rule set name and the rule set body in JSON format. Rule sets must be defined in the same Region as the matchmaking configuration they are used with.
Since matchmaking rule sets cannot be edited, it is a good idea to check the rule set syntax using ValidateMatchmakingRuleSet before creating a new rule set.
Learn more
Related actions
CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet | DeleteMatchmakingRuleSet | All APIs by task
", - "CreatePlayerSession": "Reserves an open player slot in a game session for a player. New player sessions can be created in any game session with an open slot that is in ACTIVE status and has a player creation policy of ACCEPT_ALL. You can add a group of players to a game session with CreatePlayerSessions.
To create a player session, specify a game session ID, player ID, and optionally a set of player data.
If successful, a slot is reserved in the game session for the player and a new PlayerSession object is returned with a player session ID. The player references the player session ID when sending a connection request to the game session, and the game server can use it to validate the player reservation with the GameLift service. Player sessions cannot be updated.
The maximum number of players per game session is 200. It is not adjustable.
Available in Amazon GameLift Local.
Related actions
CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions | StartGameSessionPlacement | DescribeGameSessionPlacement | All APIs by task
", - "CreatePlayerSessions": "Reserves open slots in a game session for a group of players. New player sessions can be created in any game session with an open slot that is in ACTIVE status and has a player creation policy of ACCEPT_ALL. To add a single player to a game session, use CreatePlayerSession.
To create player sessions, specify a game session ID and a list of player IDs. Optionally, provide a set of player data for each player ID.
If successful, a slot is reserved in the game session for each player, and new PlayerSession objects are returned with player session IDs. Each player references their player session ID when sending a connection request to the game session, and the game server can use it to validate the player reservation with the GameLift service. Player sessions cannot be updated.
The maximum number of players per game session is 200. It is not adjustable.
Available in Amazon GameLift Local.
Related actions
CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions | StartGameSessionPlacement | DescribeGameSessionPlacement | All APIs by task
", - "CreateScript": "Creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that provide configuration settings and optional custom game logic for your game. The script is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is executed during an active game session.
To create a new script record, specify a script name and provide the script file(s). The script files and all dependencies must be zipped into a single file. You can pull the zip file from either of these locations:
A locally available directory. Use the ZipFile parameter for this option.
An Amazon Simple Storage Service (Amazon S3) bucket under your Amazon Web Services account. Use the StorageLocation parameter for this option. You'll need to have an Identity Access Management (IAM) role that allows the Amazon GameLift service to access your S3 bucket.
If the call is successful, a new script record is created with a unique script ID. If the script file is provided as a local file, the file is uploaded to an Amazon GameLift-owned S3 bucket and the script record's storage location reflects this location. If the script file is provided as an S3 bucket, Amazon GameLift accesses the file at this storage location as needed for deployment.
Learn more
Amazon GameLift Realtime Servers
Set Up a Role for Amazon GameLift Access
Related actions
CreateScript | ListScripts | DescribeScript | UpdateScript | DeleteScript | All APIs by task
", - "CreateVpcPeeringAuthorization": "Requests authorization to create or delete a peer connection between the VPC for your Amazon GameLift fleet and a virtual private cloud (VPC) in your Amazon Web Services account. VPC peering enables the game servers on your fleet to communicate directly with other Amazon Web Services resources. Once you've received authorization, call CreateVpcPeeringConnection to establish the peering connection. For more information, see VPC Peering with Amazon GameLift Fleets.
You can peer with VPCs that are owned by any Amazon Web Services account you have access to, including the account that you use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different Regions.
To request authorization to create a connection, call this operation from the Amazon Web Services account with the VPC that you want to peer to your Amazon GameLift fleet. For example, to enable your game servers to retrieve data from a DynamoDB table, use the account that manages that DynamoDB resource. Identify the following values: (1) The ID of the VPC that you want to peer with, and (2) the ID of the Amazon Web Services account that you use to manage Amazon GameLift. If successful, VPC peering is authorized for the specified VPC.
To request authorization to delete a connection, call this operation from the Amazon Web Services account with the VPC that is peered with your Amazon GameLift fleet. Identify the following values: (1) VPC ID that you want to delete the peering connection for, and (2) ID of the Amazon Web Services account that you use to manage Amazon GameLift.
The authorization remains valid for 24 hours unless it is canceled by a call to DeleteVpcPeeringAuthorization. You must create or delete the peering connection while the authorization is valid.
Related actions
CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections | DeleteVpcPeeringConnection | All APIs by task
", - "CreateVpcPeeringConnection": "Establishes a VPC peering connection between a virtual private cloud (VPC) in an Amazon Web Services account with the VPC for your Amazon GameLift fleet. VPC peering enables the game servers on your fleet to communicate directly with other Amazon Web Services resources. You can peer with VPCs in any Amazon Web Services account that you have access to, including the account that you use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different Regions. For more information, see VPC Peering with Amazon GameLift Fleets.
Before calling this operation to establish the peering connection, you first need to call CreateVpcPeeringAuthorization and identify the VPC you want to peer with. Once the authorization for the specified VPC is issued, you have 24 hours to establish the connection. These two operations handle all tasks necessary to peer the two VPCs, including acceptance, updating routing tables, etc.
To establish the connection, call this operation from the Amazon Web Services account that is used to manage the Amazon GameLift fleets. Identify the following values: (1) The ID of the fleet you want to be enable a VPC peering connection for; (2) The Amazon Web Services account with the VPC that you want to peer with; and (3) The ID of the VPC you want to peer with. This operation is asynchronous. If successful, a VpcPeeringConnection request is created. You can use continuous polling to track the request's status using DescribeVpcPeeringConnections, or by monitoring fleet events for success or failure using DescribeFleetEvents.
Related actions
CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections | DeleteVpcPeeringConnection | All APIs by task
", - "DeleteAlias": "Deletes an alias. This operation removes all record of the alias. Game clients attempting to access a server process using the deleted alias receive an error. To delete an alias, specify the alias ID to be deleted.
Related actions
CreateAlias | ListAliases | DescribeAlias | UpdateAlias | DeleteAlias | ResolveAlias | All APIs by task
", - "DeleteBuild": "Deletes a build. This operation permanently deletes the build resource and any uploaded build files. Deleting a build does not affect the status of any active fleets using the build, but you can no longer create new fleets with the deleted build.
To delete a build, specify the build ID.
Learn more
Related actions
CreateBuild | ListBuilds | DescribeBuild | UpdateBuild | DeleteBuild | All APIs by task
", - "DeleteFleet": "Deletes all resources and information related a fleet. Any current fleet instances, including those in remote locations, are shut down. You don't need to call DeleteFleetLocations separately.
If the fleet being deleted has a VPC peering connection, you first need to get a valid authorization (good for 24 hours) by calling CreateVpcPeeringAuthorization. You do not need to explicitly delete the VPC peering connection--this is done as part of the delete fleet process.
To delete a fleet, specify the fleet ID to be terminated. During the deletion process the fleet status is changed to DELETING. When completed, the status switches to TERMINATED and the fleet event FLEET_DELETED is sent.
Learn more
Related actions
CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations | DeleteScalingPolicy | All APIs by task
", - "DeleteFleetLocations": "Removes locations from a multi-location fleet. When deleting a location, all game server process and all instances that are still active in the location are shut down.
To delete fleet locations, identify the fleet ID and provide a list of the locations to be deleted.
If successful, GameLift sets the location status to DELETING, and begins to shut down existing server processes and terminate instances in each location being deleted. When completed, the location status changes to TERMINATED.
Learn more
Related actions
CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions | DeleteFleetLocations | All APIs by task
", - "DeleteGameServerGroup": "This operation is used with the GameLift FleetIQ solution and game server groups.
Terminates a game server group and permanently deletes the game server group record. You have several options for how these resources are impacted when deleting the game server group. Depending on the type of delete operation selected, this operation might affect these resources:
The game server group
The corresponding Auto Scaling group
All game servers that are currently running in the group
To delete a game server group, identify the game server group to delete and specify the type of delete operation to initiate. Game server groups can only be deleted if they are in ACTIVE or ERROR status.
If the delete request is successful, a series of operations are kicked off. The game server group status is changed to DELETE_SCHEDULED, which prevents new game servers from being registered and stops automatic scaling activity. Once all game servers in the game server group are deregistered, GameLift FleetIQ can begin deleting resources. If any of the delete operations fail, the game server group is placed in ERROR status.
GameLift FleetIQ emits delete events to Amazon CloudWatch.
Learn more
Related actions
CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup | SuspendGameServerGroup | DescribeGameServerInstances | All APIs by task
", - "DeleteGameSessionQueue": "Deletes a game session queue. Once a queue is successfully deleted, unfulfilled StartGameSessionPlacement requests that reference the queue will fail. To delete a queue, specify the queue name.
Learn more
Related actions
CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue | DeleteGameSessionQueue | All APIs by task
", - "DeleteMatchmakingConfiguration": "Permanently removes a FlexMatch matchmaking configuration. To delete, specify the configuration name. A matchmaking configuration cannot be deleted if it is being used in any active matchmaking tickets.
Related actions
CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet | DeleteMatchmakingRuleSet | All APIs by task
", - "DeleteMatchmakingRuleSet": "Deletes an existing matchmaking rule set. To delete the rule set, provide the rule set name. Rule sets cannot be deleted if they are currently being used by a matchmaking configuration.
Learn more
Related actions
CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet | DeleteMatchmakingRuleSet | All APIs by task
", - "DeleteScalingPolicy": "Deletes a fleet scaling policy. Once deleted, the policy is no longer in force and GameLift removes all record of it. To delete a scaling policy, specify both the scaling policy name and the fleet ID it is associated with.
To temporarily suspend scaling policies, call StopFleetActions. This operation suspends all policies for the fleet.
Related actions
DescribeFleetCapacity | UpdateFleetCapacity | DescribeEC2InstanceLimits | PutScalingPolicy | DescribeScalingPolicies | DeleteScalingPolicy | StopFleetActions | StartFleetActions | All APIs by task
", - "DeleteScript": "Deletes a Realtime script. This operation permanently deletes the script record. If script files were uploaded, they are also deleted (files stored in an S3 bucket are not deleted).
To delete a script, specify the script ID. Before deleting a script, be sure to terminate all fleets that are deployed with the script being deleted. Fleet instances periodically check for script updates, and if the script record no longer exists, the instance will go into an error state and be unable to host game sessions.
Learn more
Amazon GameLift Realtime Servers
Related actions
CreateScript | ListScripts | DescribeScript | UpdateScript | DeleteScript | All APIs by task
", - "DeleteVpcPeeringAuthorization": "Cancels a pending VPC peering authorization for the specified VPC. If you need to delete an existing VPC peering connection, call DeleteVpcPeeringConnection.
Related actions
CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections | DeleteVpcPeeringConnection | All APIs by task
", - "DeleteVpcPeeringConnection": "Removes a VPC peering connection. To delete the connection, you must have a valid authorization for the VPC peering connection that you want to delete. You can check for an authorization by calling DescribeVpcPeeringAuthorizations or request a new one using CreateVpcPeeringAuthorization.
Once a valid authorization exists, call this operation from the Amazon Web Services account that is used to manage the Amazon GameLift fleets. Identify the connection to delete by the connection ID and fleet ID. If successful, the connection is removed.
Related actions
CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections | DeleteVpcPeeringConnection | All APIs by task
", - "DeregisterGameServer": "This operation is used with the GameLift FleetIQ solution and game server groups.
Removes the game server from a game server group. As a result of this operation, the deregistered game server can no longer be claimed and will not be returned in a list of active game servers.
To deregister a game server, specify the game server group and game server ID. If successful, this operation emits a CloudWatch event with termination timestamp and reason.
Learn more
Related actions
RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer | UpdateGameServer | DeregisterGameServer | All APIs by task
", - "DescribeAlias": "Retrieves properties for an alias. This operation returns all alias metadata and settings. To get an alias's target fleet ID only, use ResolveAlias.
To get alias properties, specify the alias ID. If successful, the requested alias record is returned.
Related actions
CreateAlias | ListAliases | DescribeAlias | UpdateAlias | DeleteAlias | ResolveAlias | All APIs by task
", - "DescribeBuild": "Retrieves properties for a custom game build. To request a build resource, specify a build ID. If successful, an object containing the build properties is returned.
Learn more
Related actions
CreateBuild | ListBuilds | DescribeBuild | UpdateBuild | DeleteBuild | All APIs by task
", - "DescribeEC2InstanceLimits": "Retrieves the instance limits and current utilization for an Amazon Web Services Region or location. Instance limits control the number of instances, per instance type, per location, that your Amazon Web Services account can use. Learn more at Amazon EC2 Instance Types. The information returned includes the maximum number of instances allowed and your account's current usage across all fleets. This information can affect your ability to scale your GameLift fleets. You can request a limit increase for your account by using the Service limits page in the GameLift console.
Instance limits differ based on whether the instances are deployed in a fleet's home Region or in a remote location. For remote locations, limits also differ based on the combination of home Region and remote location. All requests must specify an Amazon Web Services Region (either explicitly or as your default settings). To get the limit for a remote location, you must also specify the location. For example, the following requests all return different results:
Request specifies the Region ap-northeast-1 with no location. The result is limits and usage data on all instance types that are deployed in us-east-2, by all of the fleets that reside in ap-northeast-1.
Request specifies the Region us-east-1 with location ca-central-1. The result is limits and usage data on all instance types that are deployed in ca-central-1, by all of the fleets that reside in us-east-2. These limits do not affect fleets in any other Regions that deploy instances to ca-central-1.
Request specifies the Region eu-west-1 with location ca-central-1. The result is limits and usage data on all instance types that are deployed in ca-central-1, by all of the fleets that reside in eu-west-1.
This operation can be used in the following ways:
To get limit and usage data for all instance types that are deployed in an Amazon Web Services Region by fleets that reside in the same Region: Specify the Region only. Optionally, specify a single instance type to retrieve information for.
To get limit and usage data for all instance types that are deployed to a remote location by fleets that reside in different Amazon Web Services Region: Provide both the Amazon Web Services Region and the remote location. Optionally, specify a single instance type to retrieve information for.
If successful, an EC2InstanceLimits object is returned with limits and usage data for each requested instance type.
Learn more
Related actions
CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes | StopFleetActions | DeleteFleet | All APIs by task
", - "DescribeFleetAttributes": "Retrieves core fleet-wide properties, including the computing hardware and deployment configuration for all instances in the fleet.
This operation can be used in the following ways:
To get attributes for one or more specific fleets, provide a list of fleet IDs or fleet ARNs.
To get attributes for all fleets, do not provide a fleet identifier.
When requesting attributes for multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a FleetAttributes object is returned for each fleet requested, unless the fleet identifier is not found.
Some API operations limit the number of fleet IDs that allowed in one request. If a request exceeds this limit, the request fails and the error message contains the maximum allowed number.
Learn more
Related actions
ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration | DescribeScalingPolicies | All APIs by task
", - "DescribeFleetCapacity": "Retrieves the resource capacity settings for one or more fleets. The data returned includes the current fleet capacity (number of EC2 instances), and settings that can control how capacity scaling. For fleets with remote locations, this operation retrieves data for the fleet's home Region only. See DescribeFleetLocationCapacity to get capacity settings for a fleet's remote locations.
This operation can be used in the following ways:
To get capacity data for one or more specific fleets, provide a list of fleet IDs or fleet ARNs.
To get capacity data for all fleets, do not provide a fleet identifier.
When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a FleetCapacity object is returned for each requested fleet ID. Each FleetCapacity object includes a Location property, which is set to the fleet's home Region. When a list of fleet IDs is provided, attribute objects are returned only for fleets that currently exist.
Some API operations may limit the number of fleet IDs that are allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.
Learn more
Related actions
ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration | DescribeScalingPolicies | All APIs by task
", - "DescribeFleetEvents": "Retrieves entries from a fleet's event log. Fleet events are initiated by changes in status, such as during fleet creation and termination, changes in capacity, etc. If a fleet has multiple locations, events are also initiated by changes to status and capacity in remote locations.
You can specify a time range to limit the result set. Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a collection of event log entries matching the request are returned.
Learn more
Related actions
ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration | DescribeScalingPolicies | All APIs by task
", - "DescribeFleetLocationAttributes": "Retrieves information on a fleet's remote locations, including life-cycle status and any suspended fleet activity.
This operation can be used in the following ways:
To get data for specific locations, provide a fleet identifier and a list of locations. Location data is returned in the order that it is requested.
To get data for all locations, provide a fleet identifier only. Location data is returned in no particular order.
When requesting attributes for multiple locations, use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a LocationAttributes object is returned for each requested location. If the fleet does not have a requested location, no information is returned. This operation does not return the home Region. To get information on a fleet's home Region, call DescribeFleetAttributes.
Learn more
Related actions
CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions | DeleteFleetLocations | All APIs by task
", - "DescribeFleetLocationCapacity": "Retrieves the resource capacity settings for a fleet location. The data returned includes the current capacity (number of EC2 instances) and some scaling settings for the requested fleet location. Use this operation to retrieve capacity information for a fleet's remote location or home Region (you can also retrieve home Region capacity by calling DescribeFleetCapacity).
To retrieve capacity data, identify a fleet and location.
If successful, a FleetCapacity object is returned for the requested fleet location.
Learn more
Related actions
CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions | DeleteFleetLocations | All APIs by task
", - "DescribeFleetLocationUtilization": "Retrieves current usage data for a fleet location. Utilization data provides a snapshot of current game hosting activity at the requested location. Use this operation to retrieve utilization information for a fleet's remote location or home Region (you can also retrieve home Region utilization by calling DescribeFleetUtilization).
To retrieve utilization data, identify a fleet and location.
If successful, a FleetUtilization object is returned for the requested fleet location.
Learn more
Related actions
CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions | DeleteFleetLocations | All APIs by task
", - "DescribeFleetPortSettings": "Retrieves a fleet's inbound connection permissions. Connection permissions specify the range of IP addresses and port settings that incoming traffic can use to access server processes in the fleet. Game sessions that are running on instances in the fleet must use connections that fall in this range.
This operation can be used in the following ways:
To retrieve the inbound connection permissions for a fleet, identify the fleet's unique identifier.
To check the status of recent updates to a fleet remote location, specify the fleet ID and a location. Port setting updates can take time to propagate across all locations.
If successful, a set of IpPermission objects is returned for the requested fleet ID. When a location is specified, a pending status is included. If the requested fleet has been deleted, the result set is empty.
Learn more
Related actions
ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration | DescribeScalingPolicies | All APIs by task
", - "DescribeFleetUtilization": "Retrieves utilization statistics for one or more fleets. Utilization data provides a snapshot of how the fleet's hosting resources are currently being used. For fleets with remote locations, this operation retrieves data for the fleet's home Region only. See DescribeFleetLocationUtilization to get utilization statistics for a fleet's remote locations.
This operation can be used in the following ways:
To get utilization data for one or more specific fleets, provide a list of fleet IDs or fleet ARNs.
To get utilization data for all fleets, do not provide a fleet identifier.
When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a FleetUtilization object is returned for each requested fleet ID, unless the fleet identifier is not found. Each fleet utilization object includes a Location property, which is set to the fleet's home Region.
Some API operations may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.
Learn more
Related actions
ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration | DescribeScalingPolicies | All APIs by task
", - "DescribeGameServer": "This operation is used with the GameLift FleetIQ solution and game server groups.
Retrieves information for a registered game server. Information includes game server status, health check info, and the instance that the game server is running on.
To retrieve game server information, specify the game server ID. If successful, the requested game server object is returned.
Learn more
Related actions
RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer | UpdateGameServer | DeregisterGameServer | All APIs by task
", - "DescribeGameServerGroup": "This operation is used with the GameLift FleetIQ solution and game server groups.
Retrieves information on a game server group. This operation returns only properties related to GameLift FleetIQ. To view or update properties for the corresponding Auto Scaling group, such as launch template, auto scaling policies, and maximum/minimum group size, access the Auto Scaling group directly.
To get attributes for a game server group, provide a group name or ARN value. If successful, a GameServerGroup object is returned.
Learn more
Related actions
CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup | SuspendGameServerGroup | DescribeGameServerInstances | All APIs by task
", - "DescribeGameServerInstances": "This operation is used with the GameLift FleetIQ solution and game server groups.
Retrieves status information about the Amazon EC2 instances associated with a GameLift FleetIQ game server group. Use this operation to detect when instances are active or not available to host new game servers. If you are looking for instance configuration information, call DescribeGameServerGroup or access the corresponding Auto Scaling group properties.
To request status for all instances in the game server group, provide a game server group ID only. To request status for specific instances, provide the game server group ID and one or more instance IDs. Use the pagination parameters to retrieve results in sequential segments. If successful, a collection of GameServerInstance objects is returned.
This operation is not designed to be called with every game server claim request; this practice can cause you to exceed your API limit, which results in errors. Instead, as a best practice, cache the results and refresh your cache no more than once every 10 seconds.
Learn more
Related actions
CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup | SuspendGameServerGroup | DescribeGameServerInstances | All APIs by task
", - "DescribeGameSessionDetails": "Retrieves additional game session properties, including the game session protection policy in force, a set of one or more game sessions in a specific fleet location. You can optionally filter the results by current game session status. Alternatively, use SearchGameSessions to request a set of active game sessions that are filtered by certain criteria. To retrieve all game session properties, use DescribeGameSessions.
This operation can be used in the following ways:
To retrieve details for all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID, with an optional status filter. This approach returns details from the fleet's home Region and all remote locations.
To retrieve details for all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name, with optional status filter. The location can be the fleet's home Region or any remote location.
To retrieve details for a specific game session, provide the game session ID. This approach looks for the game session ID in all fleets that reside in the Amazon Web Services Region defined in the request.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a GameSessionDetail object is returned for each game session that matches the request.
Learn more
Related actions
CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task
", - "DescribeGameSessionPlacement": "Retrieves information, including current status, about a game session placement request.
To get game session placement details, specify the placement ID.
This operation is not designed to be continually called to track game session status. This practice can cause you to exceed your API limit, which results in errors. Instead, you must configure configure an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling with DescribeGameSessionPlacement should only be used for games in development with low game session usage.
If successful, a GameSessionPlacement object is returned.
Related actions
CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task
", - "DescribeGameSessionQueues": "Retrieves the properties for one or more game session queues. When requesting multiple queues, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSessionQueue object is returned for each requested queue. When specifying a list of queues, objects are returned only for queues that currently exist in the Region.
Learn more
Related actions
CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue | DeleteGameSessionQueue | All APIs by task
", - "DescribeGameSessions": "Retrieves a set of one or more game sessions in a specific fleet location. You can optionally filter the results by current game session status. Alternatively, use SearchGameSessions to request a set of active game sessions that are filtered by certain criteria. To retrieve the protection policy for game sessions, use DescribeGameSessionDetails.
This operation is not designed to be continually called to track game session status. This practice can cause you to exceed your API limit, which results in errors. Instead, you must configure configure an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling with DescribeGameSessions should only be used for games in development with low game session usage.
This operation can be used in the following ways:
To retrieve all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID, with an optional status filter. This approach returns all game sessions in the fleet's home Region and all remote locations.
To retrieve all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name, with optional status filter. The location can be the fleet's home Region or any remote location.
To retrieve a specific game session, provide the game session ID. This approach looks for the game session ID in all fleets that reside in the Amazon Web Services Region defined in the request.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a GameSession object is returned for each game session that matches the request.
This operation is not designed to be continually called to track matchmaking ticket status. This practice can cause you to exceed your API limit, which results in errors. Instead, as a best practice, set up an Amazon Simple Notification Service to receive notifications, and provide the topic ARN in the matchmaking configuration. Continuously poling ticket status with DescribeGameSessions should only be used for games in development with low matchmaking usage.
Available in Amazon GameLift Local.
Learn more
Related actions
CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task
", - "DescribeInstances": "Retrieves information about a fleet's instances, including instance IDs, connection data, and status.
This operation can be used in the following ways:
To get information on all instances that are deployed to a fleet's home Region, provide the fleet ID.
To get information on all instances that are deployed to a fleet's remote location, provide the fleet ID and location name.
To get information on a specific instance in a fleet, provide the fleet ID and instance ID.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, an Instance object is returned for each requested instance. Instances are not returned in any particular order.
Learn more
Remotely Access Fleet Instances
Related actions
DescribeInstances | GetInstanceAccess | DescribeEC2InstanceLimits | All APIs by task
", - "DescribeMatchmaking": "Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket information, including--after a successful match is made--connection information for the resulting new game session.
To request matchmaking tickets, provide a list of up to 10 ticket IDs. If the request is successful, a ticket object is returned for each requested ID that currently exists.
This operation is not designed to be continually called to track matchmaking ticket status. This practice can cause you to exceed your API limit, which results in errors. Instead, as a best practice, set up an Amazon Simple Notification Service to receive notifications, and provide the topic ARN in the matchmaking configuration. Continuously polling ticket status with DescribeMatchmaking should only be used for games in development with low matchmaking usage.
Learn more
Add FlexMatch to a game client
Set Up FlexMatch event notification
Related actions
StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch | StartMatchBackfill | All APIs by task
", - "DescribeMatchmakingConfigurations": "Retrieves the details of FlexMatch matchmaking configurations.
This operation offers the following options: (1) retrieve all matchmaking configurations, (2) retrieve configurations for a specified list, or (3) retrieve all configurations that use a specified rule set name. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a configuration is returned for each requested name. When specifying a list of names, only configurations that currently exist are returned.
Learn more
Setting up FlexMatch matchmakers
Related actions
CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet | DeleteMatchmakingRuleSet | All APIs by task
", - "DescribeMatchmakingRuleSets": "Retrieves the details for FlexMatch matchmaking rule sets. You can request all existing rule sets for the Region, or provide a list of one or more rule set names. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a rule set is returned for each requested name.
Learn more
Related actions
CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet | DeleteMatchmakingRuleSet | All APIs by task
", - "DescribePlayerSessions": "Retrieves properties for one or more player sessions.
This action can be used in the following ways:
To retrieve a specific player session, provide the player session ID only.
To retrieve all player sessions in a game session, provide the game session ID only.
To retrieve all player sessions for a specific player, provide a player ID only.
To request player sessions, specify either a player session ID, game session ID, or player ID. You can filter this request by player session status. Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a PlayerSession object is returned for each session that matches the request.
Available in Amazon GameLift Local.
Related actions
CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions | StartGameSessionPlacement | DescribeGameSessionPlacement | All APIs by task
", - "DescribeRuntimeConfiguration": "Retrieves a fleet's runtime configuration settings. The runtime configuration tells GameLift which server processes to run (and how) on each instance in the fleet.
To get the runtime configuration that is currently in forces for a fleet, provide the fleet ID.
If successful, a RuntimeConfiguration object is returned for the requested fleet. If the requested fleet has been deleted, the result set is empty.
Learn more
Running multiple processes on a fleet
Related actions
ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration | DescribeScalingPolicies | All APIs by task
", - "DescribeScalingPolicies": "Retrieves all scaling policies applied to a fleet.
To get a fleet's scaling policies, specify the fleet ID. You can filter this request by policy status, such as to retrieve only active scaling policies. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, set of ScalingPolicy objects is returned for the fleet.
A fleet may have all of its scaling policies suspended (StopFleetActions). This operation does not affect the status of the scaling policies, which remains ACTIVE. To see whether a fleet's scaling policies are in force or suspended, call DescribeFleetAttributes and check the stopped actions.
Related actions
DescribeFleetCapacity | UpdateFleetCapacity | DescribeEC2InstanceLimits | PutScalingPolicy | DescribeScalingPolicies | DeleteScalingPolicy | StopFleetActions | StartFleetActions | All APIs by task
", - "DescribeScript": "Retrieves properties for a Realtime script.
To request a script record, specify the script ID. If successful, an object containing the script properties is returned.
Learn more
Amazon GameLift Realtime Servers
Related actions
CreateScript | ListScripts | DescribeScript | UpdateScript | DeleteScript | All APIs by task
", - "DescribeVpcPeeringAuthorizations": "Retrieves valid VPC peering authorizations that are pending for the Amazon Web Services account. This operation returns all VPC peering authorizations and requests for peering. This includes those initiated and received by this account.
Related actions
CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections | DeleteVpcPeeringConnection | All APIs by task
", - "DescribeVpcPeeringConnections": "Retrieves information on VPC peering connections. Use this operation to get peering information for all fleets or for one specific fleet ID.
To retrieve connection information, call this operation from the Amazon Web Services account that is used to manage the Amazon GameLift fleets. Specify a fleet ID or leave the parameter empty to retrieve all connection records. If successful, the retrieved information includes both active and pending connections. Active connections identify the IpV4 CIDR block that the VPC uses to connect.
Related actions
CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections | DeleteVpcPeeringConnection | All APIs by task
", - "GetGameSessionLogUrl": "Retrieves the location of stored game session logs for a specified game session. When a game session is terminated, GameLift automatically stores the logs in Amazon S3 and retains them for 14 days. Use this URL to download the logs.
See the Amazon Web Services Service Limits page for maximum log file sizes. Log files that exceed this limit are not saved.
Related actions
CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task
", - "GetInstanceAccess": "Requests remote access to a fleet instance. Remote access is useful for debugging, gathering benchmarking data, or observing activity in real time.
To remotely access an instance, you need credentials that match the operating system of the instance. For a Windows instance, GameLift returns a user name and password as strings for use with a Windows Remote Desktop client. For a Linux instance, GameLift returns a user name and RSA private key, also as strings, for use with an SSH client. The private key must be saved in the proper format to a .pem file before using. If you're making this request using the CLI, saving the secret can be handled as part of the GetInstanceAccess request, as shown in one of the examples for this operation.
To request access to a specific instance, specify the IDs of both the instance and the fleet it belongs to. You can retrieve a fleet's instance IDs by calling DescribeInstances. If successful, an InstanceAccess object is returned that contains the instance's IP address and a set of credentials.
Learn more
Remotely Access Fleet Instances
Related actions
DescribeInstances | GetInstanceAccess | DescribeEC2InstanceLimits | All APIs by task
", - "ListAliases": "Retrieves all aliases for this Amazon Web Services account. You can filter the result set by alias name and/or routing strategy type. Use the pagination parameters to retrieve results in sequential pages.
Returned aliases are not listed in any particular order.
Related actions
CreateAlias | ListAliases | DescribeAlias | UpdateAlias | DeleteAlias | ResolveAlias | All APIs by task
", - "ListBuilds": "Retrieves build resources for all builds associated with the Amazon Web Services account in use. You can limit results to builds that are in a specific status by using the Status parameter. Use the pagination parameters to retrieve results in a set of sequential pages.
Build resources are not listed in any particular order.
Learn more
Related actions
CreateBuild | ListBuilds | DescribeBuild | UpdateBuild | DeleteBuild | All APIs by task
", - "ListFleets": "Retrieves a collection of fleet resources in an Amazon Web Services Region. You can call this operation to get fleets in a previously selected default Region (see https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.htmlor specify a Region in your request. You can filter the result set to find only those fleets that are deployed with a specific build or script. For fleets that have multiple locations, this operation retrieves fleets based on their home Region only.
This operation can be used in the following ways:
To get a list of all fleets in a Region, don't provide a build or script identifier.
To get a list of all fleets where a specific custom game build is deployed, provide the build ID.
To get a list of all Realtime Servers fleets with a specific configuration script, provide the script ID.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a list of fleet IDs that match the request parameters is returned. A NextToken value is also returned if there are more result pages to retrieve.
Fleet resources are not listed in a particular order.
Learn more
Related actions
CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes | StopFleetActions | DeleteFleet | All APIs by task
", - "ListGameServerGroups": "This operation is used with the GameLift FleetIQ solution and game server groups.
Retrieves information on all game servers groups that exist in the current Amazon Web Services account for the selected Region. Use the pagination parameters to retrieve results in a set of sequential segments.
Learn more
Related actions
CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup | SuspendGameServerGroup | DescribeGameServerInstances | All APIs by task
", - "ListGameServers": "This operation is used with the GameLift FleetIQ solution and game server groups.
Retrieves information on all game servers that are currently active in a specified game server group. You can opt to sort the list by game server age. Use the pagination parameters to retrieve results in a set of sequential segments.
Learn more
Related actions
RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer | UpdateGameServer | DeregisterGameServer | All APIs by task
", - "ListScripts": "Retrieves script records for all Realtime scripts that are associated with the Amazon Web Services account in use.
Learn more
Amazon GameLift Realtime Servers
Related actions
CreateScript | ListScripts | DescribeScript | UpdateScript | DeleteScript | All APIs by task
", - "ListTagsForResource": "Retrieves all tags that are assigned to a GameLift resource. Resource tags are used to organize Amazon Web Services resources for a range of purposes. This operation handles the permissions necessary to manage tags for the following GameLift resource types:
Build
Script
Fleet
Alias
GameSessionQueue
MatchmakingConfiguration
MatchmakingRuleSet
To list tags for a resource, specify the unique ARN value for the resource.
Learn more
Tagging Amazon Web Services Resources in the Amazon Web Services General Reference
Amazon Web Services Tagging Strategies
Related actions
TagResource | UntagResource | ListTagsForResource | All APIs by task
", - "PutScalingPolicy": "Creates or updates a scaling policy for a fleet. Scaling policies are used to automatically scale a fleet's hosting capacity to meet player demand. An active scaling policy instructs Amazon GameLift to track a fleet metric and automatically change the fleet's capacity when a certain threshold is reached. There are two types of scaling policies: target-based and rule-based. Use a target-based policy to quickly and efficiently manage fleet scaling; this option is the most commonly used. Use rule-based policies when you need to exert fine-grained control over auto-scaling.
Fleets can have multiple scaling policies of each type in force at the same time; you can have one target-based policy, one or multiple rule-based scaling policies, or both. We recommend caution, however, because multiple auto-scaling policies can have unintended consequences.
You can temporarily suspend all scaling policies for a fleet by calling StopFleetActions with the fleet action AUTO_SCALING. To resume scaling policies, call StartFleetActions with the same fleet action. To stop just one scaling policy--or to permanently remove it, you must delete the policy with DeleteScalingPolicy.
Learn more about how to work with auto-scaling in Set Up Fleet Automatic Scaling.
Target-based policy
A target-based policy tracks a single metric: PercentAvailableGameSessions. This metric tells us how much of a fleet's hosting capacity is ready to host game sessions but is not currently in use. This is the fleet's buffer; it measures the additional player demand that the fleet could handle at current capacity. With a target-based policy, you set your ideal buffer size and leave it to Amazon GameLift to take whatever action is needed to maintain that target.
For example, you might choose to maintain a 10% buffer for a fleet that has the capacity to host 100 simultaneous game sessions. This policy tells Amazon GameLift to take action whenever the fleet's available capacity falls below or rises above 10 game sessions. Amazon GameLift will start new instances or stop unused instances in order to return to the 10% buffer.
To create or update a target-based policy, specify a fleet ID and name, and set the policy type to \"TargetBased\". Specify the metric to track (PercentAvailableGameSessions) and reference a TargetConfiguration object with your desired buffer value. Exclude all other parameters. On a successful request, the policy name is returned. The scaling policy is automatically in force as soon as it's successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted.
Rule-based policy
A rule-based policy tracks specified fleet metric, sets a threshold value, and specifies the type of action to initiate when triggered. With a rule-based policy, you can select from several available fleet metrics. Each policy specifies whether to scale up or scale down (and by how much), so you need one policy for each type of action.
For example, a policy may make the following statement: \"If the percentage of idle instances is greater than 20% for more than 15 minutes, then reduce the fleet capacity by 10%.\"
A policy's rule statement has the following structure:
If [MetricName] is [ComparisonOperator] [Threshold] for [EvaluationPeriods] minutes, then [ScalingAdjustmentType] to/by [ScalingAdjustment].
To implement the example, the rule statement would look like this:
If [PercentIdleInstances] is [GreaterThanThreshold] [20] for [15] minutes, then [PercentChangeInCapacity] to/by [10].
To create or update a scaling policy, specify a unique combination of name and fleet ID, and set the policy type to \"RuleBased\". Specify the parameter values for a policy rule statement. On a successful request, the policy name is returned. Scaling policies are automatically in force as soon as they're successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted.
Related actions
DescribeFleetCapacity | UpdateFleetCapacity | DescribeEC2InstanceLimits | PutScalingPolicy | DescribeScalingPolicies | DeleteScalingPolicy | StopFleetActions | StartFleetActions | All APIs by task
", - "RegisterGameServer": "This operation is used with the GameLift FleetIQ solution and game server groups.
Creates a new game server resource and notifies GameLift FleetIQ that the game server is ready to host gameplay and players. This operation is called by a game server process that is running on an instance in a game server group. Registering game servers enables GameLift FleetIQ to track available game servers and enables game clients and services to claim a game server for a new game session.
To register a game server, identify the game server group and instance where the game server is running, and provide a unique identifier for the game server. You can also include connection and game server data. When a game client or service requests a game server by calling ClaimGameServer, this information is returned in the response.
Once a game server is successfully registered, it is put in status AVAILABLE. A request to register a game server may fail if the instance it is running on is in the process of shutting down as part of instance balancing or scale-down activity.
Learn more
Related actions
RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer | UpdateGameServer | DeregisterGameServer | All APIs by task
", - "RequestUploadCredentials": "Retrieves a fresh set of credentials for use when uploading a new set of game build files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; see CreateBuild.
To request new credentials, specify the build ID as returned with an initial CreateBuild request. If successful, a new set of credentials are returned, along with the S3 storage location associated with the build ID.
Learn more
Create a Build with Files in S3
Related actions
CreateBuild | ListBuilds | DescribeBuild | UpdateBuild | DeleteBuild | All APIs by task
", - "ResolveAlias": "Retrieves the fleet ID that an alias is currently pointing to.
Related actions
CreateAlias | ListAliases | DescribeAlias | UpdateAlias | DeleteAlias | ResolveAlias | All APIs by task
", - "ResumeGameServerGroup": "This operation is used with the GameLift FleetIQ solution and game server groups.
Reinstates activity on a game server group after it has been suspended. A game server group might be suspended by theSuspendGameServerGroup operation, or it might be suspended involuntarily due to a configuration problem. In the second case, you can manually resume activity on the group once the configuration problem has been resolved. Refer to the game server group status and status reason for more information on why group activity is suspended.
To resume activity, specify a game server group ARN and the type of activity to be resumed. If successful, a GameServerGroup object is returned showing that the resumed activity is no longer listed in SuspendedActions.
Learn more
Related actions
CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup | SuspendGameServerGroup | DescribeGameServerInstances | All APIs by task
", - "SearchGameSessions": "Retrieves all active game sessions that match a set of search criteria and sorts them into a specified order.
This operation is not designed to be continually called to track game session status. This practice can cause you to exceed your API limit, which results in errors. Instead, you must configure configure an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling game session status with DescribeGameSessions should only be used for games in development with low game session usage.
When searching for game sessions, you specify exactly where you want to search and provide a search filter expression, a sort expression, or both. A search request can search only one fleet, but it can search all of a fleet's locations.
This operation can be used in the following ways:
To search all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID. This approach returns game sessions in the fleet's home Region and all remote locations that fit the search criteria.
To search all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name. For location, you can specify a fleet's home Region or any remote location.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a GameSession object is returned for each game session that matches the request. Search finds game sessions that are in ACTIVE status only. To retrieve information on game sessions in other statuses, use DescribeGameSessions.
You can search or sort by the following game session attributes:
gameSessionId -- A unique identifier for the game session. You can use either a GameSessionId or GameSessionArn value.
gameSessionName -- Name assigned to a game session. This value is set when requesting a new game session with CreateGameSession or updating with UpdateGameSession. Game session names do not need to be unique to a game session.
gameSessionProperties -- Custom data defined in a game session's GameProperty parameter. GameProperty values are stored as key:value pairs; the filter expression must indicate the key and a string to search the data values for. For example, to search for game sessions with custom data containing the key:value pair \"gameMode:brawl\", specify the following: gameSessionProperties.gameMode = \"brawl\". All custom data values are searched as strings.
maximumSessions -- Maximum number of player sessions allowed for a game session. This value is set when requesting a new game session with CreateGameSession or updating with UpdateGameSession.
creationTimeMillis -- Value indicating when a game session was created. It is expressed in Unix time as milliseconds.
playerSessionCount -- Number of players currently connected to a game session. This value changes rapidly as players join the session or drop out.
hasAvailablePlayerSessions -- Boolean value indicating whether a game session has reached its maximum number of players. It is highly recommended that all search requests include this filter attribute to optimize search performance and return only sessions that players can join.
Returned values for playerSessionCount and hasAvailablePlayerSessions change quickly as players join sessions and others drop out. Results should be considered a snapshot in time. Be sure to refresh search results often, and handle sessions that fill up before a player can join.
Related actions
CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task
", - "StartFleetActions": "Resumes certain types of activity on fleet instances that were suspended with StopFleetActions. For multi-location fleets, fleet actions are managed separately for each location. Currently, this operation is used to restart a fleet's auto-scaling activity.
This operation can be used in the following ways:
To restart actions on instances in the fleet's home Region, provide a fleet ID and the type of actions to resume.
To restart actions on instances in one of the fleet's remote locations, provide a fleet ID, a location name, and the type of actions to resume.
If successful, GameLift once again initiates scaling events as triggered by the fleet's scaling policies. If actions on the fleet location were never stopped, this operation will have no effect. You can view a fleet's stopped actions using DescribeFleetAttributes or DescribeFleetLocationAttributes.
Learn more
Related actions
CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes | StopFleetActions | DeleteFleet | All APIs by task
", - "StartGameSessionPlacement": "Places a request for a new game session in a queue (see CreateGameSessionQueue). When processing a placement request, Amazon GameLift searches for available resources on the queue's destinations, scanning each until it finds resources or the placement request times out.
A game session placement request can also request player sessions. When a new game session is successfully created, Amazon GameLift creates a player session for each player included in the request.
When placing a game session, by default Amazon GameLift tries each fleet in the order they are listed in the queue configuration. Ideally, a queue's destinations are listed in preference order.
Alternatively, when requesting a game session with players, you can also provide latency data for each player in relevant Regions. Latency data indicates the performance lag a player experiences when connected to a fleet in the Region. Amazon GameLift uses latency data to reorder the list of destinations to place the game session in a Region with minimal lag. If latency data is provided for multiple players, Amazon GameLift calculates each Region's average lag for all players and reorders to get the best game play across all players.
To place a new game session request, specify the following:
The queue name and a set of game session properties and settings
A unique ID (such as a UUID) for the placement. You use this ID to track the status of the placement request
(Optional) A set of player data and a unique player ID for each player that you are joining to the new game session (player data is optional, but if you include it, you must also provide a unique ID for each player)
Latency data for all players (if you want to optimize game play for the players)
If successful, a new game session placement is created.
To track the status of a placement request, call DescribeGameSessionPlacement and check the request's status. If the status is FULFILLED, a new game session has been created and a game session ARN and Region are referenced. If the placement request times out, you can resubmit the request or retry it with a different queue.
Related actions
CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task
", - "StartMatchBackfill": "Finds new players to fill open slots in currently running game sessions. The backfill match process is essentially identical to the process of forming new matches. Backfill requests use the same matchmaker that was used to make the original match, and they provide matchmaking data for all players currently in the game session. FlexMatch uses this information to select new players so that backfilled match continues to meet the original match requirements.
When using FlexMatch with GameLift managed hosting, you can request a backfill match from a client service by calling this operation with a GameSession identifier. You also have the option of making backfill requests directly from your game server. In response to a request, FlexMatch creates player sessions for the new players, updates the GameSession resource, and sends updated matchmaking data to the game server. You can request a backfill match at any point after a game session is started. Each game session can have only one active backfill request at a time; a subsequent request automatically replaces the earlier request.
When using FlexMatch as a standalone component, request a backfill match by calling this operation without a game session identifier. As with newly formed matches, matchmaking results are returned in a matchmaking event so that your game can update the game session that is being backfilled.
To request a backfill match, specify a unique ticket ID, the original matchmaking configuration, and matchmaking data for all current players in the game session being backfilled. Optionally, specify the GameSession ARN. If successful, a match backfill ticket is created and returned with status set to QUEUED. Track the status of backfill tickets using the same method for tracking tickets for new matches.
Only game sessions created by FlexMatch are supported for match backfill.
Learn more
Backfill existing games with FlexMatch
Matchmaking events (reference)
Related actions
StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch | StartMatchBackfill | All APIs by task
", - "StartMatchmaking": "Uses FlexMatch to create a game match for a group of players based on custom matchmaking rules. With games that use GameLift managed hosting, this operation also triggers GameLift to find hosting resources and start a new game session for the new match. Each matchmaking request includes information on one or more players and specifies the FlexMatch matchmaker to use. When a request is for multiple players, FlexMatch attempts to build a match that includes all players in the request, placing them in the same team and finding additional players as needed to fill the match.
To start matchmaking, provide a unique ticket ID, specify a matchmaking configuration, and include the players to be matched. You must also include any player attributes that are required by the matchmaking configuration's rule set. If successful, a matchmaking ticket is returned with status set to QUEUED.
Track matchmaking events to respond as needed and acquire game session connection information for successfully completed matches. Ticket status updates are tracked using event notification through Amazon Simple Notification Service, which is defined in the matchmaking configuration.
Learn more
Add FlexMatch to a game client
Set Up FlexMatch event notification
Related actions
StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch | StartMatchBackfill | All APIs by task
", - "StopFleetActions": "Suspends certain types of activity in a fleet location. Currently, this operation is used to stop auto-scaling activity. For multi-location fleets, fleet actions are managed separately for each location.
Stopping fleet actions has several potential purposes. It allows you to temporarily stop auto-scaling activity but retain your scaling policies for use in the future. For multi-location fleets, you can set up fleet-wide auto-scaling, and then opt out of it for certain locations.
This operation can be used in the following ways:
To stop actions on instances in the fleet's home Region, provide a fleet ID and the type of actions to suspend.
To stop actions on instances in one of the fleet's remote locations, provide a fleet ID, a location name, and the type of actions to suspend.
If successful, GameLift no longer initiates scaling events except in response to manual changes using UpdateFleetCapacity. You can view a fleet's stopped actions using DescribeFleetAttributes or DescribeFleetLocationAttributes. Suspended activity can be restarted using StartFleetActions.
Learn more
Related actions
CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes | StopFleetActions | DeleteFleet | All APIs by task
", - "StopGameSessionPlacement": "Cancels a game session placement that is in PENDING status. To stop a placement, provide the placement ID values. If successful, the placement is moved to CANCELLED status.
Related actions
CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task
", - "StopMatchmaking": "Cancels a matchmaking ticket or match backfill ticket that is currently being processed. To stop the matchmaking operation, specify the ticket ID. If successful, work on the ticket is stopped, and the ticket status is changed to CANCELLED.
This call is also used to turn off automatic backfill for an individual game session. This is for game sessions that are created with a matchmaking configuration that has automatic backfill enabled. The ticket ID is included in the MatchmakerData of an updated game session object, which is provided to the game server.
If the operation is successful, the service sends back an empty JSON struct with the HTTP 200 response (not an empty HTTP body).
Learn more
Add FlexMatch to a game client
Related actions
StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch | StartMatchBackfill | All APIs by task
", - "SuspendGameServerGroup": "This operation is used with the GameLift FleetIQ solution and game server groups.
Temporarily stops activity on a game server group without terminating instances or the game server group. You can restart activity by calling ResumeGameServerGroup. You can suspend the following activity:
Instance type replacement - This activity evaluates the current game hosting viability of all Spot instance types that are defined for the game server group. It updates the Auto Scaling group to remove nonviable Spot Instance types, which have a higher chance of game server interruptions. It then balances capacity across the remaining viable Spot Instance types. When this activity is suspended, the Auto Scaling group continues with its current balance, regardless of viability. Instance protection, utilization metrics, and capacity scaling activities continue to be active.
To suspend activity, specify a game server group ARN and the type of activity to be suspended. If successful, a GameServerGroup object is returned showing that the activity is listed in SuspendedActions.
Learn more
Related actions
CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup | SuspendGameServerGroup | DescribeGameServerInstances | All APIs by task
", - "TagResource": "Assigns a tag to a GameLift resource. Amazon Web Services resource tags provide an additional management tool set. You can use tags to organize resources, create IAM permissions policies to manage access to groups of resources, customize Amazon Web Services cost breakdowns, etc. This operation handles the permissions necessary to manage tags for the following GameLift resource types:
Build
Script
Fleet
Alias
GameSessionQueue
MatchmakingConfiguration
MatchmakingRuleSet
To add a tag to a resource, specify the unique ARN value for the resource and provide a tag list containing one or more tags. The operation succeeds even if the list includes tags that are already assigned to the specified resource.
Learn more
Tagging Amazon Web Services Resources in the Amazon Web Services General Reference
Amazon Web Services Tagging Strategies
Related actions
TagResource | UntagResource | ListTagsForResource | All APIs by task
", - "UntagResource": "Removes a tag that is assigned to a GameLift resource. Resource tags are used to organize Amazon Web Services resources for a range of purposes. This operation handles the permissions necessary to manage tags for the following GameLift resource types:
Build
Script
Fleet
Alias
GameSessionQueue
MatchmakingConfiguration
MatchmakingRuleSet
To remove a tag from a resource, specify the unique ARN value for the resource and provide a string list containing one or more tags to be removed. This operation succeeds even if the list includes tags that are not currently assigned to the specified resource.
Learn more
Tagging Amazon Web Services Resources in the Amazon Web Services General Reference
Amazon Web Services Tagging Strategies
Related actions
TagResource | UntagResource | ListTagsForResource | All APIs by task
", - "UpdateAlias": "Updates properties for an alias. To update properties, specify the alias ID to be updated and provide the information to be changed. To reassign an alias to another fleet, provide an updated routing strategy. If successful, the updated alias record is returned.
Related actions
CreateAlias | ListAliases | DescribeAlias | UpdateAlias | DeleteAlias | ResolveAlias | All APIs by task
", - "UpdateBuild": "Updates metadata in a build resource, including the build name and version. To update the metadata, specify the build ID to update and provide the new values. If successful, a build object containing the updated metadata is returned.
Learn more
Related actions
CreateBuild | ListBuilds | DescribeBuild | UpdateBuild | DeleteBuild | All APIs by task
", - "UpdateFleetAttributes": "Updates a fleet's mutable attributes, including game session protection and resource creation limits.
To update fleet attributes, specify the fleet ID and the property values that you want to change.
If successful, an updated FleetAttributes object is returned.
Learn more
Related actions
CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations | DeleteScalingPolicy | All APIs by task
", - "UpdateFleetCapacity": "Updates capacity settings for a fleet. For fleets with multiple locations, use this operation to manage capacity settings in each location individually. Fleet capacity determines the number of game sessions and players that can be hosted based on the fleet configuration. Use this operation to set the following fleet capacity properties:
Minimum/maximum size: Set hard limits on fleet capacity. GameLift cannot set the fleet's capacity to a value outside of this range, whether the capacity is changed manually or through automatic scaling.
Desired capacity: Manually set the number of Amazon EC2 instances to be maintained in a fleet location. Before changing a fleet's desired capacity, you may want to call DescribeEC2InstanceLimits to get the maximum capacity of the fleet's Amazon EC2 instance type. Alternatively, consider using automatic scaling to adjust capacity based on player demand.
This operation can be used in the following ways:
To update capacity for a fleet's home Region, or if the fleet has no remote locations, omit the Location parameter. The fleet must be in ACTIVE status.
To update capacity for a fleet's remote location, include the Location parameter set to the location to be updated. The location must be in ACTIVE status.
If successful, capacity settings are updated immediately. In response a change in desired capacity, GameLift initiates steps to start new instances or terminate existing instances in the requested fleet location. This continues until the location's active instance count matches the new desired instance count. You can track a fleet's current capacity by calling DescribeFleetCapacity or DescribeFleetLocationCapacity. If the requested desired instance count is higher than the instance type's limit, the LimitExceeded exception occurs.
Learn more
Related actions
CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations | DeleteScalingPolicy | All APIs by task
", - "UpdateFleetPortSettings": "Updates permissions that allow inbound traffic to connect to game sessions that are being hosted on instances in the fleet.
To update settings, specify the fleet ID to be updated and specify the changes to be made. List the permissions you want to add in InboundPermissionAuthorizations, and permissions you want to remove in InboundPermissionRevocations. Permissions to be removed must match existing fleet permissions.
If successful, the fleet ID for the updated fleet is returned. For fleets with remote locations, port setting updates can take time to propagate across all locations. You can check the status of updates in each location by calling DescribeFleetPortSettings with a location name.
Learn more
Related actions
CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations | DeleteScalingPolicy | All APIs by task
", - "UpdateGameServer": "This operation is used with the GameLift FleetIQ solution and game server groups.
Updates information about a registered game server to help GameLift FleetIQ to track game server availability. This operation is called by a game server process that is running on an instance in a game server group.
Use this operation to update the following types of game server information. You can make all three types of updates in the same request:
To update the game server's utilization status, identify the game server and game server group and specify the current utilization status. Use this status to identify when game servers are currently hosting games and when they are available to be claimed.
To report health status, identify the game server and game server group and set health check to HEALTHY. If a game server does not report health status for a certain length of time, the game server is no longer considered healthy. As a result, it will be eventually deregistered from the game server group to avoid affecting utilization metrics. The best practice is to report health every 60 seconds.
To change game server metadata, provide updated game server data.
Once a game server is successfully updated, the relevant statuses and timestamps are updated.
Learn more
Related actions
RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer | UpdateGameServer | DeregisterGameServer | All APIs by task
", - "UpdateGameServerGroup": "This operation is used with the GameLift FleetIQ solution and game server groups.
Updates GameLift FleetIQ-specific properties for a game server group. Many Auto Scaling group properties are updated on the Auto Scaling group directly, including the launch template, Auto Scaling policies, and maximum/minimum/desired instance counts.
To update the game server group, specify the game server group ID and provide the updated values. Before applying the updates, the new values are validated to ensure that GameLift FleetIQ can continue to perform instance balancing activity. If successful, a GameServerGroup object is returned.
Learn more
Related actions
CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup | SuspendGameServerGroup | DescribeGameServerInstances | All APIs by task
", - "UpdateGameSession": "Updates the mutable properties of a game session.
To update a game session, specify the game session ID and the values you want to change.
If successful, the updated GameSession object is returned.
Related actions
CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task
", - "UpdateGameSessionQueue": "Updates the configuration of a game session queue, which determines how the queue processes new game session requests. To update settings, specify the queue name to be updated and provide the new settings. When updating destinations, provide a complete list of destinations.
Learn more
Related actions
CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue | DeleteGameSessionQueue | All APIs by task
", - "UpdateMatchmakingConfiguration": "Updates settings for a FlexMatch matchmaking configuration. These changes affect all matches and game sessions that are created after the update. To update settings, specify the configuration name to be updated and provide the new settings.
Learn more
Related actions
CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet | DeleteMatchmakingRuleSet | All APIs by task
", - "UpdateRuntimeConfiguration": "Updates the current runtime configuration for the specified fleet, which tells GameLift how to launch server processes on all instances in the fleet. You can update a fleet's runtime configuration at any time after the fleet is created; it does not need to be in ACTIVE status.
To update runtime configuration, specify the fleet ID and provide a RuntimeConfiguration with an updated set of server process configurations.
If successful, the fleet's runtime configuration settings are updated. Each instance in the fleet regularly checks for and retrieves updated runtime configurations. Instances immediately begin complying with the new configuration by launching new server processes or not replacing existing processes when they shut down. Updating a fleet's runtime configuration never affects existing server processes.
Learn more
Related actions
CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations | DeleteScalingPolicy | All APIs by task
", - "UpdateScript": "Updates Realtime script metadata and content.
To update script metadata, specify the script ID and provide updated name and/or version values.
To update script content, provide an updated zip file by pointing to either a local file or an Amazon S3 bucket location. You can use either method regardless of how the original script was uploaded. Use the Version parameter to track updates to the script.
If the call is successful, the updated metadata is stored in the script record and a revised script is uploaded to the Amazon GameLift service. Once the script is updated and acquired by a fleet instance, the new version is used for all new game sessions.
Learn more
Amazon GameLift Realtime Servers
Related actions
CreateScript | ListScripts | DescribeScript | UpdateScript | DeleteScript | All APIs by task
", - "ValidateMatchmakingRuleSet": "Validates the syntax of a matchmaking rule or rule set. This operation checks that the rule set is using syntactically correct JSON and that it conforms to allowed property expressions. To validate syntax, provide a rule set JSON string.
Learn more
Related actions
CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet | DeleteMatchmakingRuleSet | All APIs by task
" + "CreateLocation": "Creates a custom location for use in an Anywhere fleet.
", + "CreateMatchmakingConfiguration": "Defines a new matchmaking configuration for use with FlexMatch. Whether your are using FlexMatch with GameLift hosting or as a standalone matchmaking service, the matchmaking configuration sets out rules for matching players and forming teams. If you're also using GameLift hosting, it defines how to start game sessions for each match. Your matchmaking system can use multiple configurations to handle different game scenarios. All matchmaking requests identify the matchmaking configuration to use and provide player attributes consistent with that configuration.
To create a matchmaking configuration, you must provide the following: configuration name and FlexMatch mode (with or without GameLift hosting); a rule set that specifies how to evaluate players and find acceptable matches; whether player acceptance is required; and the maximum time allowed for a matchmaking attempt. When using FlexMatch with GameLift hosting, you also need to identify the game session queue to use when starting a game session for the match.
In addition, you must set up an Amazon Simple Notification Service topic to receive matchmaking notifications. Provide the topic ARN in the matchmaking configuration.
Learn more
Set up FlexMatch event notification
", + "CreateMatchmakingRuleSet": "Creates a new rule set for FlexMatch matchmaking. A rule set describes the type of match to create, such as the number and size of teams. It also sets the parameters for acceptable player matches, such as minimum skill level or character type.
To create a matchmaking rule set, provide unique rule set name and the rule set body in JSON format. Rule sets must be defined in the same Region as the matchmaking configuration they are used with.
Since matchmaking rule sets cannot be edited, it is a good idea to check the rule set syntax using ValidateMatchmakingRuleSet before creating a new rule set.
Learn more
", + "CreatePlayerSession": "Reserves an open player slot in a game session for a player. New player sessions can be created in any game session with an open slot that is in ACTIVE status and has a player creation policy of ACCEPT_ALL. You can add a group of players to a game session with CreatePlayerSessions .
To create a player session, specify a game session ID, player ID, and optionally a set of player data.
If successful, a slot is reserved in the game session for the player and a new PlayerSessions object is returned with a player session ID. The player references the player session ID when sending a connection request to the game session, and the game server can use it to validate the player reservation with the GameLift service. Player sessions cannot be updated.
The maximum number of players per game session is 200. It is not adjustable.
Related actions
", + "CreatePlayerSessions": "Reserves open slots in a game session for a group of players. New player sessions can be created in any game session with an open slot that is in ACTIVE status and has a player creation policy of ACCEPT_ALL. To add a single player to a game session, use CreatePlayerSession
To create player sessions, specify a game session ID and a list of player IDs. Optionally, provide a set of player data for each player ID.
If successful, a slot is reserved in the game session for each player, and new PlayerSession objects are returned with player session IDs. Each player references their player session ID when sending a connection request to the game session, and the game server can use it to validate the player reservation with the GameLift service. Player sessions cannot be updated.
The maximum number of players per game session is 200. It is not adjustable.
Related actions
", + "CreateScript": "Creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that provide configuration settings and optional custom game logic for your game. The script is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is executed during an active game session.
To create a new script record, specify a script name and provide the script file(s). The script files and all dependencies must be zipped into a single file. You can pull the zip file from either of these locations:
A locally available directory. Use the ZipFile parameter for this option.
An Amazon Simple Storage Service (Amazon S3) bucket under your Amazon Web Services account. Use the StorageLocation parameter for this option. You'll need to have an Identity Access Management (IAM) role that allows the Amazon GameLift service to access your S3 bucket.
If the call is successful, a new script record is created with a unique script ID. If the script file is provided as a local file, the file is uploaded to an Amazon GameLift-owned S3 bucket and the script record's storage location reflects this location. If the script file is provided as an S3 bucket, Amazon GameLift accesses the file at this storage location as needed for deployment.
Learn more
Amazon GameLift Realtime Servers
Set Up a Role for Amazon GameLift Access
Related actions
", + "CreateVpcPeeringAuthorization": "Requests authorization to create or delete a peer connection between the VPC for your Amazon GameLift fleet and a virtual private cloud (VPC) in your Amazon Web Services account. VPC peering enables the game servers on your fleet to communicate directly with other Amazon Web Services resources. After you've received authorization, use CreateVpcPeeringConnection to establish the peering connection. For more information, see VPC Peering with Amazon GameLift Fleets.
You can peer with VPCs that are owned by any Amazon Web Services account you have access to, including the account that you use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different Regions.
To request authorization to create a connection, call this operation from the Amazon Web Services account with the VPC that you want to peer to your Amazon GameLift fleet. For example, to enable your game servers to retrieve data from a DynamoDB table, use the account that manages that DynamoDB resource. Identify the following values: (1) The ID of the VPC that you want to peer with, and (2) the ID of the Amazon Web Services account that you use to manage Amazon GameLift. If successful, VPC peering is authorized for the specified VPC.
To request authorization to delete a connection, call this operation from the Amazon Web Services account with the VPC that is peered with your Amazon GameLift fleet. Identify the following values: (1) VPC ID that you want to delete the peering connection for, and (2) ID of the Amazon Web Services account that you use to manage Amazon GameLift.
The authorization remains valid for 24 hours unless it is canceled. You must create or delete the peering connection while the authorization is valid.
Related actions
", + "CreateVpcPeeringConnection": "Establishes a VPC peering connection between a virtual private cloud (VPC) in an Amazon Web Services account with the VPC for your Amazon GameLift fleet. VPC peering enables the game servers on your fleet to communicate directly with other Amazon Web Services resources. You can peer with VPCs in any Amazon Web Services account that you have access to, including the account that you use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different Regions. For more information, see VPC Peering with Amazon GameLift Fleets.
Before calling this operation to establish the peering connection, you first need to use CreateVpcPeeringAuthorization and identify the VPC you want to peer with. Once the authorization for the specified VPC is issued, you have 24 hours to establish the connection. These two operations handle all tasks necessary to peer the two VPCs, including acceptance, updating routing tables, etc.
To establish the connection, call this operation from the Amazon Web Services account that is used to manage the Amazon GameLift fleets. Identify the following values: (1) The ID of the fleet you want to be enable a VPC peering connection for; (2) The Amazon Web Services account with the VPC that you want to peer with; and (3) The ID of the VPC you want to peer with. This operation is asynchronous. If successful, a connection request is created. You can use continuous polling to track the request's status using DescribeVpcPeeringConnections , or by monitoring fleet events for success or failure using DescribeFleetEvents .
Related actions
", + "DeleteAlias": "Deletes an alias. This operation removes all record of the alias. Game clients attempting to access a server process using the deleted alias receive an error. To delete an alias, specify the alias ID to be deleted.
Related actions
", + "DeleteBuild": "Deletes a build. This operation permanently deletes the build resource and any uploaded build files. Deleting a build does not affect the status of any active fleets using the build, but you can no longer create new fleets with the deleted build.
To delete a build, specify the build ID.
Learn more
", + "DeleteFleet": "Deletes all resources and information related a fleet. Any current fleet instances, including those in remote locations, are shut down. You don't need to call DeleteFleetLocations separately.
If the fleet being deleted has a VPC peering connection, you first need to get a valid authorization (good for 24 hours) by calling CreateVpcPeeringAuthorization. You do not need to explicitly delete the VPC peering connection.
To delete a fleet, specify the fleet ID to be terminated. During the deletion process the fleet status is changed to DELETING. When completed, the status switches to TERMINATED and the fleet event FLEET_DELETED is sent.
Learn more
", + "DeleteFleetLocations": "Removes locations from a multi-location fleet. When deleting a location, all game server process and all instances that are still active in the location are shut down.
To delete fleet locations, identify the fleet ID and provide a list of the locations to be deleted.
If successful, GameLift sets the location status to DELETING, and begins to shut down existing server processes and terminate instances in each location being deleted. When completed, the location status changes to TERMINATED.
Learn more
", + "DeleteGameServerGroup": "This operation is used with the GameLift FleetIQ solution and game server groups.
Terminates a game server group and permanently deletes the game server group record. You have several options for how these resources are impacted when deleting the game server group. Depending on the type of delete operation selected, this operation might affect these resources:
The game server group
The corresponding Auto Scaling group
All game servers that are currently running in the group
To delete a game server group, identify the game server group to delete and specify the type of delete operation to initiate. Game server groups can only be deleted if they are in ACTIVE or ERROR status.
If the delete request is successful, a series of operations are kicked off. The game server group status is changed to DELETE_SCHEDULED, which prevents new game servers from being registered and stops automatic scaling activity. Once all game servers in the game server group are deregistered, GameLift FleetIQ can begin deleting resources. If any of the delete operations fail, the game server group is placed in ERROR status.
GameLift FleetIQ emits delete events to Amazon CloudWatch.
Learn more
", + "DeleteGameSessionQueue": "Deletes a game session queue. Once a queue is successfully deleted, unfulfilled StartGameSessionPlacement requests that reference the queue will fail. To delete a queue, specify the queue name.
", + "DeleteLocation": "Deletes a custom location.
Before deleting a custom location, review any fleets currently using the custom location and deregister the location if it is in use. For more information see, DeregisterCompute.
", + "DeleteMatchmakingConfiguration": "Permanently removes a FlexMatch matchmaking configuration. To delete, specify the configuration name. A matchmaking configuration cannot be deleted if it is being used in any active matchmaking tickets.
", + "DeleteMatchmakingRuleSet": "Deletes an existing matchmaking rule set. To delete the rule set, provide the rule set name. Rule sets cannot be deleted if they are currently being used by a matchmaking configuration.
Learn more
", + "DeleteScalingPolicy": "Deletes a fleet scaling policy. Once deleted, the policy is no longer in force and GameLift removes all record of it. To delete a scaling policy, specify both the scaling policy name and the fleet ID it is associated with.
To temporarily suspend scaling policies, use StopFleetActions. This operation suspends all policies for the fleet.
", + "DeleteScript": "Deletes a Realtime script. This operation permanently deletes the script record. If script files were uploaded, they are also deleted (files stored in an S3 bucket are not deleted).
To delete a script, specify the script ID. Before deleting a script, be sure to terminate all fleets that are deployed with the script being deleted. Fleet instances periodically check for script updates, and if the script record no longer exists, the instance will go into an error state and be unable to host game sessions.
Learn more
Amazon GameLift Realtime Servers
Related actions
", + "DeleteVpcPeeringAuthorization": "Cancels a pending VPC peering authorization for the specified VPC. If you need to delete an existing VPC peering connection, use DeleteVpcPeeringConnection.
Related actions
", + "DeleteVpcPeeringConnection": "Removes a VPC peering connection. To delete the connection, you must have a valid authorization for the VPC peering connection that you want to delete..
Once a valid authorization exists, call this operation from the Amazon Web Services account that is used to manage the Amazon GameLift fleets. Identify the connection to delete by the connection ID and fleet ID. If successful, the connection is removed.
Related actions
", + "DeregisterCompute": "Removes a compute resource from the specified fleet. Deregister your compute resources before you delete the compute.
", + "DeregisterGameServer": "This operation is used with the GameLift FleetIQ solution and game server groups.
Removes the game server from a game server group. As a result of this operation, the deregistered game server can no longer be claimed and will not be returned in a list of active game servers.
To deregister a game server, specify the game server group and game server ID. If successful, this operation emits a CloudWatch event with termination timestamp and reason.
Learn more
", + "DescribeAlias": "Retrieves properties for an alias. This operation returns all alias metadata and settings. To get an alias's target fleet ID only, use ResolveAlias.
To get alias properties, specify the alias ID. If successful, the requested alias record is returned.
Related actions
", + "DescribeBuild": "Retrieves properties for a custom game build. To request a build resource, specify a build ID. If successful, an object containing the build properties is returned.
Learn more
", + "DescribeCompute": "Retrieves properties for a compute resource. To request a compute resource specify the fleet ID and compute name. If successful, GameLift returns an object containing the build properties.
", + "DescribeEC2InstanceLimits": "Retrieves the instance limits and current utilization for an Amazon Web Services Region or location. Instance limits control the number of instances, per instance type, per location, that your Amazon Web Services account can use. Learn more at Amazon EC2 Instance Types. The information returned includes the maximum number of instances allowed and your account's current usage across all fleets. This information can affect your ability to scale your GameLift fleets. You can request a limit increase for your account by using the Service limits page in the GameLift console.
Instance limits differ based on whether the instances are deployed in a fleet's home Region or in a remote location. For remote locations, limits also differ based on the combination of home Region and remote location. All requests must specify an Amazon Web Services Region (either explicitly or as your default settings). To get the limit for a remote location, you must also specify the location. For example, the following requests all return different results:
Request specifies the Region ap-northeast-1 with no location. The result is limits and usage data on all instance types that are deployed in us-east-2, by all of the fleets that reside in ap-northeast-1.
Request specifies the Region us-east-1 with location ca-central-1. The result is limits and usage data on all instance types that are deployed in ca-central-1, by all of the fleets that reside in us-east-2. These limits do not affect fleets in any other Regions that deploy instances to ca-central-1.
Request specifies the Region eu-west-1 with location ca-central-1. The result is limits and usage data on all instance types that are deployed in ca-central-1, by all of the fleets that reside in eu-west-1.
This operation can be used in the following ways:
To get limit and usage data for all instance types that are deployed in an Amazon Web Services Region by fleets that reside in the same Region: Specify the Region only. Optionally, specify a single instance type to retrieve information for.
To get limit and usage data for all instance types that are deployed to a remote location by fleets that reside in different Amazon Web Services Region: Provide both the Amazon Web Services Region and the remote location. Optionally, specify a single instance type to retrieve information for.
If successful, an EC2InstanceLimits object is returned with limits and usage data for each requested instance type.
Learn more
", + "DescribeFleetAttributes": "Retrieves core fleet-wide properties, including the computing hardware and deployment configuration for all instances in the fleet.
This operation can be used in the following ways:
To get attributes for one or more specific fleets, provide a list of fleet IDs or fleet ARNs.
To get attributes for all fleets, do not provide a fleet identifier.
When requesting attributes for multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a FleetAttributes object is returned for each fleet requested, unless the fleet identifier is not found.
Some API operations limit the number of fleet IDs that allowed in one request. If a request exceeds this limit, the request fails and the error message contains the maximum allowed number.
Learn more
", + "DescribeFleetCapacity": "Retrieves the resource capacity settings for one or more fleets. The data returned includes the current fleet capacity (number of EC2 instances), and settings that can control how capacity scaling. For fleets with remote locations, this operation retrieves data for the fleet's home Region only.
This operation can be used in the following ways:
To get capacity data for one or more specific fleets, provide a list of fleet IDs or fleet ARNs.
To get capacity data for all fleets, do not provide a fleet identifier.
When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a FleetCapacity object is returned for each requested fleet ID. Each FleetCapacity object includes a Location property, which is set to the fleet's home Region. When a list of fleet IDs is provided, attribute objects are returned only for fleets that currently exist.
Some API operations may limit the number of fleet IDs that are allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.
Learn more
", + "DescribeFleetEvents": "Retrieves entries from a fleet's event log. Fleet events are initiated by changes in status, such as during fleet creation and termination, changes in capacity, etc. If a fleet has multiple locations, events are also initiated by changes to status and capacity in remote locations.
You can specify a time range to limit the result set. Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a collection of event log entries matching the request are returned.
Learn more
", + "DescribeFleetLocationAttributes": "Retrieves information on a fleet's remote locations, including life-cycle status and any suspended fleet activity.
This operation can be used in the following ways:
To get data for specific locations, provide a fleet identifier and a list of locations. Location data is returned in the order that it is requested.
To get data for all locations, provide a fleet identifier only. Location data is returned in no particular order.
When requesting attributes for multiple locations, use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a LocationAttributes object is returned for each requested location. If the fleet does not have a requested location, no information is returned. This operation does not return the home Region. To get information on a fleet's home Region, call DescribeFleetAttributes.
Learn more
", + "DescribeFleetLocationCapacity": "Retrieves the resource capacity settings for a fleet location. The data returned includes the current capacity (number of EC2 instances) and some scaling settings for the requested fleet location. Use this operation to retrieve capacity information for a fleet's remote location or home Region (you can also retrieve home Region capacity by calling DescribeFleetCapacity).
To retrieve capacity data, identify a fleet and location.
If successful, a FleetCapacity object is returned for the requested fleet location.
Learn more
", + "DescribeFleetLocationUtilization": "Retrieves current usage data for a fleet location. Utilization data provides a snapshot of current game hosting activity at the requested location. Use this operation to retrieve utilization information for a fleet's remote location or home Region (you can also retrieve home Region utilization by calling DescribeFleetUtilization).
To retrieve utilization data, identify a fleet and location.
If successful, a FleetUtilization object is returned for the requested fleet location.
Learn more
", + "DescribeFleetPortSettings": "Retrieves a fleet's inbound connection permissions. Connection permissions specify the range of IP addresses and port settings that incoming traffic can use to access server processes in the fleet. Game sessions that are running on instances in the fleet must use connections that fall in this range.
This operation can be used in the following ways:
To retrieve the inbound connection permissions for a fleet, identify the fleet's unique identifier.
To check the status of recent updates to a fleet remote location, specify the fleet ID and a location. Port setting updates can take time to propagate across all locations.
If successful, a set of IpPermission objects is returned for the requested fleet ID. When a location is specified, a pending status is included. If the requested fleet has been deleted, the result set is empty.
Learn more
", + "DescribeFleetUtilization": "Retrieves utilization statistics for one or more fleets. Utilization data provides a snapshot of how the fleet's hosting resources are currently being used. For fleets with remote locations, this operation retrieves data for the fleet's home Region only. See DescribeFleetLocationUtilization to get utilization statistics for a fleet's remote locations.
This operation can be used in the following ways:
To get utilization data for one or more specific fleets, provide a list of fleet IDs or fleet ARNs.
To get utilization data for all fleets, do not provide a fleet identifier.
When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a FleetUtilization object is returned for each requested fleet ID, unless the fleet identifier is not found. Each fleet utilization object includes a Location property, which is set to the fleet's home Region.
Some API operations may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.
Learn more
", + "DescribeGameServer": "This operation is used with the GameLift FleetIQ solution and game server groups.
Retrieves information for a registered game server. Information includes game server status, health check info, and the instance that the game server is running on.
To retrieve game server information, specify the game server ID. If successful, the requested game server object is returned.
Learn more
", + "DescribeGameServerGroup": "This operation is used with the GameLift FleetIQ solution and game server groups.
Retrieves information on a game server group. This operation returns only properties related to GameLift FleetIQ. To view or update properties for the corresponding Auto Scaling group, such as launch template, auto scaling policies, and maximum/minimum group size, access the Auto Scaling group directly.
To get attributes for a game server group, provide a group name or ARN value. If successful, a GameServerGroup object is returned.
Learn more
", + "DescribeGameServerInstances": "This operation is used with the GameLift FleetIQ solution and game server groups.
Retrieves status information about the Amazon EC2 instances associated with a GameLift FleetIQ game server group. Use this operation to detect when instances are active or not available to host new game servers.
To request status for all instances in the game server group, provide a game server group ID only. To request status for specific instances, provide the game server group ID and one or more instance IDs. Use the pagination parameters to retrieve results in sequential segments. If successful, a collection of GameServerInstance objects is returned.
This operation is not designed to be called with every game server claim request; this practice can cause you to exceed your API limit, which results in errors. Instead, as a best practice, cache the results and refresh your cache no more than once every 10 seconds.
Learn more
", + "DescribeGameSessionDetails": "Retrieves additional game session properties, including the game session protection policy in force, a set of one or more game sessions in a specific fleet location. You can optionally filter the results by current game session status.
This operation can be used in the following ways:
To retrieve details for all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID, with an optional status filter. This approach returns details from the fleet's home Region and all remote locations.
To retrieve details for all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name, with optional status filter. The location can be the fleet's home Region or any remote location.
To retrieve details for a specific game session, provide the game session ID. This approach looks for the game session ID in all fleets that reside in the Amazon Web Services Region defined in the request.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a GameSessionDetail object is returned for each game session that matches the request.
Learn more
", + "DescribeGameSessionPlacement": "Retrieves information, including current status, about a game session placement request.
To get game session placement details, specify the placement ID.
This operation is not designed to be continually called to track game session status. This practice can cause you to exceed your API limit, which results in errors. Instead, you must configure configure an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling with DescribeGameSessionPlacement should only be used for games in development with low game session usage.
Retrieves the properties for one or more game session queues. When requesting multiple queues, use the pagination parameters to retrieve results as a set of sequential pages. When specifying a list of queues, objects are returned only for queues that currently exist in the Region.
Learn more
", + "DescribeGameSessions": "Retrieves a set of one or more game sessions in a specific fleet location. You can optionally filter the results by current game session status.
This operation can be used in the following ways:
To retrieve all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID, with an optional status filter. This approach returns all game sessions in the fleet's home Region and all remote locations.
To retrieve all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name, with optional status filter. The location can be the fleet's home Region or any remote location.
To retrieve a specific game session, provide the game session ID. This approach looks for the game session ID in all fleets that reside in the Amazon Web Services Region defined in the request.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a GameSession object is returned for each game session that matches the request.
This operation is not designed to be continually called to track game session status. This practice can cause you to exceed your API limit, which results in errors. Instead, you must configure an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling with DescribeGameSessions should only be used for games in development with low game session usage.
Available in Amazon GameLift Local.
Learn more
", + "DescribeInstances": "Retrieves information about a fleet's instances, including instance IDs, connection data, and status.
This operation can be used in the following ways:
To get information on all instances that are deployed to a fleet's home Region, provide the fleet ID.
To get information on all instances that are deployed to a fleet's remote location, provide the fleet ID and location name.
To get information on a specific instance in a fleet, provide the fleet ID and instance ID.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, an Instance object is returned for each requested instance. Instances are not returned in any particular order.
Learn more
Remotely Access Fleet Instances
Related actions
", + "DescribeMatchmaking": "Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket information, including--after a successful match is made--connection information for the resulting new game session.
To request matchmaking tickets, provide a list of up to 10 ticket IDs. If the request is successful, a ticket object is returned for each requested ID that currently exists.
This operation is not designed to be continually called to track matchmaking ticket status. This practice can cause you to exceed your API limit, which results in errors. Instead, as a best practice, set up an Amazon Simple Notification Service to receive notifications, and provide the topic ARN in the matchmaking configuration.
Learn more
Add FlexMatch to a game client
Set Up FlexMatch event notification
", + "DescribeMatchmakingConfigurations": "Retrieves the details of FlexMatch matchmaking configurations.
This operation offers the following options: (1) retrieve all matchmaking configurations, (2) retrieve configurations for a specified list, or (3) retrieve all configurations that use a specified rule set name. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a configuration is returned for each requested name. When specifying a list of names, only configurations that currently exist are returned.
Learn more
Setting up FlexMatch matchmakers
", + "DescribeMatchmakingRuleSets": "Retrieves the details for FlexMatch matchmaking rule sets. You can request all existing rule sets for the Region, or provide a list of one or more rule set names. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a rule set is returned for each requested name.
Learn more
", + "DescribePlayerSessions": "Retrieves properties for one or more player sessions.
This action can be used in the following ways:
To retrieve a specific player session, provide the player session ID only.
To retrieve all player sessions in a game session, provide the game session ID only.
To retrieve all player sessions for a specific player, provide a player ID only.
To request player sessions, specify either a player session ID, game session ID, or player ID. You can filter this request by player session status. Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a PlayerSession object is returned for each session that matches the request.
Related actions
", + "DescribeRuntimeConfiguration": "Retrieves a fleet's runtime configuration settings. The runtime configuration tells GameLift which server processes to run (and how) on each instance in the fleet.
To get the runtime configuration that is currently in forces for a fleet, provide the fleet ID.
If successful, a RuntimeConfiguration object is returned for the requested fleet. If the requested fleet has been deleted, the result set is empty.
Learn more
Running multiple processes on a fleet
", + "DescribeScalingPolicies": "Retrieves all scaling policies applied to a fleet.
To get a fleet's scaling policies, specify the fleet ID. You can filter this request by policy status, such as to retrieve only active scaling policies. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, set of ScalingPolicy objects is returned for the fleet.
A fleet may have all of its scaling policies suspended. This operation does not affect the status of the scaling policies, which remains ACTIVE.
", + "DescribeScript": "Retrieves properties for a Realtime script.
To request a script record, specify the script ID. If successful, an object containing the script properties is returned.
Learn more
Amazon GameLift Realtime Servers
Related actions
", + "DescribeVpcPeeringAuthorizations": "Retrieves valid VPC peering authorizations that are pending for the Amazon Web Services account. This operation returns all VPC peering authorizations and requests for peering. This includes those initiated and received by this account.
Related actions
", + "DescribeVpcPeeringConnections": "Retrieves information on VPC peering connections. Use this operation to get peering information for all fleets or for one specific fleet ID.
To retrieve connection information, call this operation from the Amazon Web Services account that is used to manage the Amazon GameLift fleets. Specify a fleet ID or leave the parameter empty to retrieve all connection records. If successful, the retrieved information includes both active and pending connections. Active connections identify the IpV4 CIDR block that the VPC uses to connect.
Related actions
", + "GetComputeAccess": "Requests remote access to a fleet instance. Remote access is useful for debugging, gathering benchmarking data, or observing activity in real time.
To remotely access an instance, you need credentials that match the operating system of the instance. For a Windows instance, GameLift returns a user name and password as strings for use with a Windows Remote Desktop client. For a Linux instance, GameLift returns a user name and RSA private key, also as strings, for use with an SSH client. The private key must be saved in the proper format to a .pem file before using. If you're making this request using the CLI, saving the secret can be handled as part of the GetInstanceAccess request, as shown in one of the examples for this operation.
To request access to a specific instance, specify the IDs of both the instance and the fleet it belongs to.
Learn more
Remotely Access Fleet Instances
", + "GetComputeAuthToken": "Requests an authorization token from GameLift. The authorization token is used by your game server to authenticate with GameLift. Each authentication token has an expiration token. To continue using the compute resource to host your game server, regularly retrieve a new authorization token.
", + "GetGameSessionLogUrl": "Retrieves the location of stored game session logs for a specified game session. When a game session is terminated, GameLift automatically stores the logs in Amazon S3 and retains them for 14 days. Use this URL to download the logs.
See the Amazon Web Services Service Limits page for maximum log file sizes. Log files that exceed this limit are not saved.
Requests remote access to a fleet instance. Remote access is useful for debugging, gathering benchmarking data, or observing activity in real time.
To remotely access an instance, you need credentials that match the operating system of the instance. For a Windows instance, GameLift returns a user name and password as strings for use with a Windows Remote Desktop client. For a Linux instance, GameLift returns a user name and RSA private key, also as strings, for use with an SSH client. The private key must be saved in the proper format to a .pem file before using. If you're making this request using the CLI, saving the secret can be handled as part of the GetInstanceAccess request, as shown in one of the examples for this operation.
To request access to a specific instance, specify the IDs of both the instance and the fleet it belongs to. You can retrieve a fleet's instance IDs by calling DescribeInstances.
Learn more
Remotely Access Fleet Instances
Related actions
", + "ListAliases": "Retrieves all aliases for this Amazon Web Services account. You can filter the result set by alias name and/or routing strategy type. Use the pagination parameters to retrieve results in sequential pages.
Returned aliases are not listed in any particular order.
Related actions
", + "ListBuilds": "Retrieves build resources for all builds associated with the Amazon Web Services account in use. You can limit results to builds that are in a specific status by using the Status parameter. Use the pagination parameters to retrieve results in a set of sequential pages.
Build resources are not listed in any particular order.
Learn more
", + "ListCompute": "Retrieves all compute resources registered to a fleet in your Amazon Web Services account. You can filter the result set by location.
", + "ListFleets": "Retrieves a collection of fleet resources in an Amazon Web Services Region. You can call this operation to get fleets in a previously selected default Region (see https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.htmlor specify a Region in your request. You can filter the result set to find only those fleets that are deployed with a specific build or script. For fleets that have multiple locations, this operation retrieves fleets based on their home Region only.
This operation can be used in the following ways:
To get a list of all fleets in a Region, don't provide a build or script identifier.
To get a list of all fleets where a specific custom game build is deployed, provide the build ID.
To get a list of all Realtime Servers fleets with a specific configuration script, provide the script ID.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a list of fleet IDs that match the request parameters is returned. A NextToken value is also returned if there are more result pages to retrieve.
Fleet resources are not listed in a particular order.
Learn more
", + "ListGameServerGroups": "Lists a game server groups.
", + "ListGameServers": "This operation is used with the GameLift FleetIQ solution and game server groups.
Retrieves information on all game servers that are currently active in a specified game server group. You can opt to sort the list by game server age. Use the pagination parameters to retrieve results in a set of sequential segments.
Learn more
", + "ListLocations": "Lists all custom and Amazon Web Services locations.
", + "ListScripts": "Retrieves script records for all Realtime scripts that are associated with the Amazon Web Services account in use.
Learn more
Amazon GameLift Realtime Servers
Related actions
", + "ListTagsForResource": "Retrieves all tags that are assigned to a GameLift resource. Resource tags are used to organize Amazon Web Services resources for a range of purposes. This operation handles the permissions necessary to manage tags for the following GameLift resource types:
Build
Script
Fleet
Alias
GameSessionQueue
MatchmakingConfiguration
MatchmakingRuleSet
To list tags for a resource, specify the unique ARN value for the resource.
Learn more
Tagging Amazon Web Services Resources in the Amazon Web Services General Reference
Amazon Web Services Tagging Strategies
Related actions
", + "PutScalingPolicy": "Creates or updates a scaling policy for a fleet. Scaling policies are used to automatically scale a fleet's hosting capacity to meet player demand. An active scaling policy instructs Amazon GameLift to track a fleet metric and automatically change the fleet's capacity when a certain threshold is reached. There are two types of scaling policies: target-based and rule-based. Use a target-based policy to quickly and efficiently manage fleet scaling; this option is the most commonly used. Use rule-based policies when you need to exert fine-grained control over auto-scaling.
Fleets can have multiple scaling policies of each type in force at the same time; you can have one target-based policy, one or multiple rule-based scaling policies, or both. We recommend caution, however, because multiple auto-scaling policies can have unintended consequences.
Learn more about how to work with auto-scaling in Set Up Fleet Automatic Scaling.
Target-based policy
A target-based policy tracks a single metric: PercentAvailableGameSessions. This metric tells us how much of a fleet's hosting capacity is ready to host game sessions but is not currently in use. This is the fleet's buffer; it measures the additional player demand that the fleet could handle at current capacity. With a target-based policy, you set your ideal buffer size and leave it to Amazon GameLift to take whatever action is needed to maintain that target.
For example, you might choose to maintain a 10% buffer for a fleet that has the capacity to host 100 simultaneous game sessions. This policy tells Amazon GameLift to take action whenever the fleet's available capacity falls below or rises above 10 game sessions. Amazon GameLift will start new instances or stop unused instances in order to return to the 10% buffer.
To create or update a target-based policy, specify a fleet ID and name, and set the policy type to \"TargetBased\". Specify the metric to track (PercentAvailableGameSessions) and reference a TargetConfiguration object with your desired buffer value. Exclude all other parameters. On a successful request, the policy name is returned. The scaling policy is automatically in force as soon as it's successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted.
Rule-based policy
A rule-based policy tracks specified fleet metric, sets a threshold value, and specifies the type of action to initiate when triggered. With a rule-based policy, you can select from several available fleet metrics. Each policy specifies whether to scale up or scale down (and by how much), so you need one policy for each type of action.
For example, a policy may make the following statement: \"If the percentage of idle instances is greater than 20% for more than 15 minutes, then reduce the fleet capacity by 10%.\"
A policy's rule statement has the following structure:
If [MetricName] is [ComparisonOperator] [Threshold] for [EvaluationPeriods] minutes, then [ScalingAdjustmentType] to/by [ScalingAdjustment].
To implement the example, the rule statement would look like this:
If [PercentIdleInstances] is [GreaterThanThreshold] [20] for [15] minutes, then [PercentChangeInCapacity] to/by [10].
To create or update a scaling policy, specify a unique combination of name and fleet ID, and set the policy type to \"RuleBased\". Specify the parameter values for a policy rule statement. On a successful request, the policy name is returned. Scaling policies are automatically in force as soon as they're successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted.
", + "RegisterCompute": "Registers your compute resources in a fleet you previously created. After you register a compute to your fleet, you can monitor and manage your compute using GameLift. The operation returns the compute resource containing SDK endpoint you can use to connect your game server to GameLift.
Learn more
", + "RegisterGameServer": "This operation is used with the GameLift FleetIQ solution and game server groups.
Creates a new game server resource and notifies GameLift FleetIQ that the game server is ready to host gameplay and players. This operation is called by a game server process that is running on an instance in a game server group. Registering game servers enables GameLift FleetIQ to track available game servers and enables game clients and services to claim a game server for a new game session.
To register a game server, identify the game server group and instance where the game server is running, and provide a unique identifier for the game server. You can also include connection and game server data.
Once a game server is successfully registered, it is put in status AVAILABLE. A request to register a game server may fail if the instance it is running on is in the process of shutting down as part of instance balancing or scale-down activity.
Learn more
", + "RequestUploadCredentials": "Retrieves a fresh set of credentials for use when uploading a new set of game build files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; see GameSession.
To request new credentials, specify the build ID as returned with an initial CreateBuild request. If successful, a new set of credentials are returned, along with the S3 storage location associated with the build ID.
Learn more
Create a Build with Files in S3
", + "ResolveAlias": "Retrieves the fleet ID that an alias is currently pointing to.
Related actions
", + "ResumeGameServerGroup": "This operation is used with the GameLift FleetIQ solution and game server groups.
Reinstates activity on a game server group after it has been suspended. A game server group might be suspended by the SuspendGameServerGroup operation, or it might be suspended involuntarily due to a configuration problem. In the second case, you can manually resume activity on the group once the configuration problem has been resolved. Refer to the game server group status and status reason for more information on why group activity is suspended.
To resume activity, specify a game server group ARN and the type of activity to be resumed. If successful, a GameServerGroup object is returned showing that the resumed activity is no longer listed in SuspendedActions.
Learn more
", + "SearchGameSessions": "Retrieves all active game sessions that match a set of search criteria and sorts them into a specified order.
This operation is not designed to be continually called to track game session status. This practice can cause you to exceed your API limit, which results in errors. Instead, you must configure configure an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling game session status with DescribeGameSessions should only be used for games in development with low game session usage.
When searching for game sessions, you specify exactly where you want to search and provide a search filter expression, a sort expression, or both. A search request can search only one fleet, but it can search all of a fleet's locations.
This operation can be used in the following ways:
To search all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID. This approach returns game sessions in the fleet's home Region and all remote locations that fit the search criteria.
To search all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name. For location, you can specify a fleet's home Region or any remote location.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a GameSession object is returned for each game session that matches the request. Search finds game sessions that are in ACTIVE status only. To retrieve information on game sessions in other statuses, use DescribeGameSessions .
You can search or sort by the following game session attributes:
gameSessionId -- A unique identifier for the game session. You can use either a GameSessionId or GameSessionArn value.
gameSessionName -- Name assigned to a game session. Game session names do not need to be unique to a game session.
gameSessionProperties -- Custom data defined in a game session's GameProperty parameter. GameProperty values are stored as key:value pairs; the filter expression must indicate the key and a string to search the data values for. For example, to search for game sessions with custom data containing the key:value pair \"gameMode:brawl\", specify the following: gameSessionProperties.gameMode = \"brawl\". All custom data values are searched as strings.
maximumSessions -- Maximum number of player sessions allowed for a game session.
creationTimeMillis -- Value indicating when a game session was created. It is expressed in Unix time as milliseconds.
playerSessionCount -- Number of players currently connected to a game session. This value changes rapidly as players join the session or drop out.
hasAvailablePlayerSessions -- Boolean value indicating whether a game session has reached its maximum number of players. It is highly recommended that all search requests include this filter attribute to optimize search performance and return only sessions that players can join.
Returned values for playerSessionCount and hasAvailablePlayerSessions change quickly as players join sessions and others drop out. Results should be considered a snapshot in time. Be sure to refresh search results often, and handle sessions that fill up before a player can join.
Resumes certain types of activity on fleet instances that were suspended with StopFleetActions. For multi-location fleets, fleet actions are managed separately for each location. Currently, this operation is used to restart a fleet's auto-scaling activity.
This operation can be used in the following ways:
To restart actions on instances in the fleet's home Region, provide a fleet ID and the type of actions to resume.
To restart actions on instances in one of the fleet's remote locations, provide a fleet ID, a location name, and the type of actions to resume.
If successful, GameLift once again initiates scaling events as triggered by the fleet's scaling policies. If actions on the fleet location were never stopped, this operation will have no effect.
Learn more
", + "StartGameSessionPlacement": "Places a request for a new game session in a queue. When processing a placement request, Amazon GameLift searches for available resources on the queue's destinations, scanning each until it finds resources or the placement request times out.
A game session placement request can also request player sessions. When a new game session is successfully created, Amazon GameLift creates a player session for each player included in the request.
When placing a game session, by default Amazon GameLift tries each fleet in the order they are listed in the queue configuration. Ideally, a queue's destinations are listed in preference order.
Alternatively, when requesting a game session with players, you can also provide latency data for each player in relevant Regions. Latency data indicates the performance lag a player experiences when connected to a fleet in the Region. Amazon GameLift uses latency data to reorder the list of destinations to place the game session in a Region with minimal lag. If latency data is provided for multiple players, Amazon GameLift calculates each Region's average lag for all players and reorders to get the best game play across all players.
To place a new game session request, specify the following:
The queue name and a set of game session properties and settings
A unique ID (such as a UUID) for the placement. You use this ID to track the status of the placement request
(Optional) A set of player data and a unique player ID for each player that you are joining to the new game session (player data is optional, but if you include it, you must also provide a unique ID for each player)
Latency data for all players (if you want to optimize game play for the players)
If successful, a new game session placement is created.
To track the status of a placement request, call DescribeGameSessionPlacement and check the request's status. If the status is FULFILLED, a new game session has been created and a game session ARN and Region are referenced. If the placement request times out, you can resubmit the request or retry it with a different queue.
Finds new players to fill open slots in currently running game sessions. The backfill match process is essentially identical to the process of forming new matches. Backfill requests use the same matchmaker that was used to make the original match, and they provide matchmaking data for all players currently in the game session. FlexMatch uses this information to select new players so that backfilled match continues to meet the original match requirements.
When using FlexMatch with GameLift managed hosting, you can request a backfill match from a client service by calling this operation with a GameSessions ID. You also have the option of making backfill requests directly from your game server. In response to a request, FlexMatch creates player sessions for the new players, updates the GameSession resource, and sends updated matchmaking data to the game server. You can request a backfill match at any point after a game session is started. Each game session can have only one active backfill request at a time; a subsequent request automatically replaces the earlier request.
When using FlexMatch as a standalone component, request a backfill match by calling this operation without a game session identifier. As with newly formed matches, matchmaking results are returned in a matchmaking event so that your game can update the game session that is being backfilled.
To request a backfill match, specify a unique ticket ID, the original matchmaking configuration, and matchmaking data for all current players in the game session being backfilled. Optionally, specify the GameSession ARN. If successful, a match backfill ticket is created and returned with status set to QUEUED. Track the status of backfill tickets using the same method for tracking tickets for new matches.
Only game sessions created by FlexMatch are supported for match backfill.
Learn more
Backfill existing games with FlexMatch
Matchmaking events (reference)
", + "StartMatchmaking": "Uses FlexMatch to create a game match for a group of players based on custom matchmaking rules. With games that use GameLift managed hosting, this operation also triggers GameLift to find hosting resources and start a new game session for the new match. Each matchmaking request includes information on one or more players and specifies the FlexMatch matchmaker to use. When a request is for multiple players, FlexMatch attempts to build a match that includes all players in the request, placing them in the same team and finding additional players as needed to fill the match.
To start matchmaking, provide a unique ticket ID, specify a matchmaking configuration, and include the players to be matched. You must also include any player attributes that are required by the matchmaking configuration's rule set. If successful, a matchmaking ticket is returned with status set to QUEUED.
Track matchmaking events to respond as needed and acquire game session connection information for successfully completed matches. Ticket status updates are tracked using event notification through Amazon Simple Notification Service, which is defined in the matchmaking configuration.
Learn more
Add FlexMatch to a game client
Set Up FlexMatch event notification
", + "StopFleetActions": "Suspends certain types of activity in a fleet location. Currently, this operation is used to stop auto-scaling activity. For multi-location fleets, fleet actions are managed separately for each location.
Stopping fleet actions has several potential purposes. It allows you to temporarily stop auto-scaling activity but retain your scaling policies for use in the future. For multi-location fleets, you can set up fleet-wide auto-scaling, and then opt out of it for certain locations.
This operation can be used in the following ways:
To stop actions on instances in the fleet's home Region, provide a fleet ID and the type of actions to suspend.
To stop actions on instances in one of the fleet's remote locations, provide a fleet ID, a location name, and the type of actions to suspend.
If successful, GameLift no longer initiates scaling events except in response to manual changes using UpdateFleetCapacity.
Learn more
", + "StopGameSessionPlacement": "Cancels a game session placement that is in PENDING status. To stop a placement, provide the placement ID values. If successful, the placement is moved to CANCELLED status.
Cancels a matchmaking ticket or match backfill ticket that is currently being processed. To stop the matchmaking operation, specify the ticket ID. If successful, work on the ticket is stopped, and the ticket status is changed to CANCELLED.
This call is also used to turn off automatic backfill for an individual game session. This is for game sessions that are created with a matchmaking configuration that has automatic backfill enabled. The ticket ID is included in the MatchmakerData of an updated game session object, which is provided to the game server.
If the operation is successful, the service sends back an empty JSON struct with the HTTP 200 response (not an empty HTTP body).
Learn more
Add FlexMatch to a game client
", + "SuspendGameServerGroup": "This operation is used with the GameLift FleetIQ solution and game server groups.
Temporarily stops activity on a game server group without terminating instances or the game server group. You can restart activity by calling ResumeGameServerGroup. You can suspend the following activity:
Instance type replacement - This activity evaluates the current game hosting viability of all Spot instance types that are defined for the game server group. It updates the Auto Scaling group to remove nonviable Spot Instance types, which have a higher chance of game server interruptions. It then balances capacity across the remaining viable Spot Instance types. When this activity is suspended, the Auto Scaling group continues with its current balance, regardless of viability. Instance protection, utilization metrics, and capacity scaling activities continue to be active.
To suspend activity, specify a game server group ARN and the type of activity to be suspended. If successful, a GameServerGroup object is returned showing that the activity is listed in SuspendedActions.
Learn more
", + "TagResource": "Assigns a tag to a GameLift resource. Amazon Web Services resource tags provide an additional management tool set. You can use tags to organize resources, create IAM permissions policies to manage access to groups of resources, customize Amazon Web Services cost breakdowns, etc. This operation handles the permissions necessary to manage tags for the following GameLift resource types:
Build
Script
Fleet
Alias
GameSessionQueue
MatchmakingConfiguration
MatchmakingRuleSet
To add a tag to a resource, specify the unique ARN value for the resource and provide a tag list containing one or more tags. The operation succeeds even if the list includes tags that are already assigned to the specified resource.
Learn more
Tagging Amazon Web Services Resources in the Amazon Web Services General Reference
Amazon Web Services Tagging Strategies
Related actions
", + "UntagResource": "Removes a tag that is assigned to a GameLift resource. Resource tags are used to organize Amazon Web Services resources for a range of purposes. This operation handles the permissions necessary to manage tags for the following GameLift resource types:
Build
Script
Fleet
Alias
GameSessionQueue
MatchmakingConfiguration
MatchmakingRuleSet
To remove a tag from a resource, specify the unique ARN value for the resource and provide a string list containing one or more tags to be removed. This operation succeeds even if the list includes tags that are not currently assigned to the specified resource.
Learn more
Tagging Amazon Web Services Resources in the Amazon Web Services General Reference
Amazon Web Services Tagging Strategies
Related actions
", + "UpdateAlias": "Updates properties for an alias. To update properties, specify the alias ID to be updated and provide the information to be changed. To reassign an alias to another fleet, provide an updated routing strategy. If successful, the updated alias record is returned.
Related actions
", + "UpdateBuild": "Updates metadata in a build resource, including the build name and version. To update the metadata, specify the build ID to update and provide the new values. If successful, a build object containing the updated metadata is returned.
Learn more
", + "UpdateFleetAttributes": "Updates a fleet's mutable attributes, including game session protection and resource creation limits.
To update fleet attributes, specify the fleet ID and the property values that you want to change.
If successful, an updated FleetAttributes object is returned.
Learn more
", + "UpdateFleetCapacity": "Updates capacity settings for a fleet. For fleets with multiple locations, use this operation to manage capacity settings in each location individually. Fleet capacity determines the number of game sessions and players that can be hosted based on the fleet configuration. Use this operation to set the following fleet capacity properties:
Minimum/maximum size: Set hard limits on fleet capacity. GameLift cannot set the fleet's capacity to a value outside of this range, whether the capacity is changed manually or through automatic scaling.
Desired capacity: Manually set the number of Amazon EC2 instances to be maintained in a fleet location. Before changing a fleet's desired capacity, you may want to call DescribeEC2InstanceLimits to get the maximum capacity of the fleet's Amazon EC2 instance type. Alternatively, consider using automatic scaling to adjust capacity based on player demand.
This operation can be used in the following ways:
To update capacity for a fleet's home Region, or if the fleet has no remote locations, omit the Location parameter. The fleet must be in ACTIVE status.
To update capacity for a fleet's remote location, include the Location parameter set to the location to be updated. The location must be in ACTIVE status.
If successful, capacity settings are updated immediately. In response a change in desired capacity, GameLift initiates steps to start new instances or terminate existing instances in the requested fleet location. This continues until the location's active instance count matches the new desired instance count. You can track a fleet's current capacity by calling DescribeFleetCapacity or DescribeFleetLocationCapacity. If the requested desired instance count is higher than the instance type's limit, the LimitExceeded exception occurs.
Learn more
", + "UpdateFleetPortSettings": "Updates permissions that allow inbound traffic to connect to game sessions that are being hosted on instances in the fleet.
To update settings, specify the fleet ID to be updated and specify the changes to be made. List the permissions you want to add in InboundPermissionAuthorizations, and permissions you want to remove in InboundPermissionRevocations. Permissions to be removed must match existing fleet permissions.
If successful, the fleet ID for the updated fleet is returned. For fleets with remote locations, port setting updates can take time to propagate across all locations. You can check the status of updates in each location by calling DescribeFleetPortSettings with a location name.
Learn more
", + "UpdateGameServer": "This operation is used with the GameLift FleetIQ solution and game server groups.
Updates information about a registered game server to help GameLift FleetIQ to track game server availability. This operation is called by a game server process that is running on an instance in a game server group.
Use this operation to update the following types of game server information. You can make all three types of updates in the same request:
To update the game server's utilization status, identify the game server and game server group and specify the current utilization status. Use this status to identify when game servers are currently hosting games and when they are available to be claimed.
To report health status, identify the game server and game server group and set health check to HEALTHY. If a game server does not report health status for a certain length of time, the game server is no longer considered healthy. As a result, it will be eventually deregistered from the game server group to avoid affecting utilization metrics. The best practice is to report health every 60 seconds.
To change game server metadata, provide updated game server data.
Once a game server is successfully updated, the relevant statuses and timestamps are updated.
Learn more
", + "UpdateGameServerGroup": "This operation is used with the GameLift FleetIQ solution and game server groups.
Updates GameLift FleetIQ-specific properties for a game server group. Many Auto Scaling group properties are updated on the Auto Scaling group directly, including the launch template, Auto Scaling policies, and maximum/minimum/desired instance counts.
To update the game server group, specify the game server group ID and provide the updated values. Before applying the updates, the new values are validated to ensure that GameLift FleetIQ can continue to perform instance balancing activity. If successful, a GameServerGroup object is returned.
Learn more
", + "UpdateGameSession": "Updates the mutable properties of a game session.
To update a game session, specify the game session ID and the values you want to change.
If successful, the updated GameSession object is returned.
Updates the configuration of a game session queue, which determines how the queue processes new game session requests. To update settings, specify the queue name to be updated and provide the new settings. When updating destinations, provide a complete list of destinations.
Learn more
", + "UpdateMatchmakingConfiguration": "Updates settings for a FlexMatch matchmaking configuration. These changes affect all matches and game sessions that are created after the update. To update settings, specify the configuration name to be updated and provide the new settings.
Learn more
", + "UpdateRuntimeConfiguration": "Updates the current runtime configuration for the specified fleet, which tells GameLift how to launch server processes on all instances in the fleet. You can update a fleet's runtime configuration at any time after the fleet is created; it does not need to be in ACTIVE status.
To update runtime configuration, specify the fleet ID and provide a RuntimeConfiguration with an updated set of server process configurations.
If successful, the fleet's runtime configuration settings are updated. Each instance in the fleet regularly checks for and retrieves updated runtime configurations. Instances immediately begin complying with the new configuration by launching new server processes or not replacing existing processes when they shut down. Updating a fleet's runtime configuration never affects existing server processes.
Learn more
", + "UpdateScript": "Updates Realtime script metadata and content.
To update script metadata, specify the script ID and provide updated name and/or version values.
To update script content, provide an updated zip file by pointing to either a local file or an Amazon S3 bucket location. You can use either method regardless of how the original script was uploaded. Use the Version parameter to track updates to the script.
If the call is successful, the updated metadata is stored in the script record and a revised script is uploaded to the Amazon GameLift service. Once the script is updated and acquired by a fleet instance, the new version is used for all new game sessions.
Learn more
Amazon GameLift Realtime Servers
Related actions
", + "ValidateMatchmakingRuleSet": "Validates the syntax of a matchmaking rule or rule set. This operation checks that the rule set is using syntactically correct JSON and that it conforms to allowed property expressions. To validate syntax, provide a rule set JSON string.
Learn more
" }, "shapes": { "AcceptMatchInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, @@ -116,7 +125,7 @@ } }, "Alias": { - "base": "Properties that describe an alias resource.
Related actions
CreateAlias | ListAliases | DescribeAlias | UpdateAlias | DeleteAlias | ResolveAlias | All APIs by task
", + "base": "Properties that describe an alias resource.
Related actions
", "refs": { "AliasList$member": null, "CreateAliasOutput$Alias": "The newly created alias resource.
", @@ -158,11 +167,19 @@ "AmazonResourceName": { "base": null, "refs": { - "ListTagsForResourceRequest$ResourceARN": "The Amazon Resource Name (ARN) that is assigned to and uniquely identifies the GameLift resource that you want to retrieve tags for. GameLift resource ARNs are included in the data object for the resource, which can be retrieved by calling a List or Describe operation for the resource type.
", - "TagResourceRequest$ResourceARN": "The Amazon Resource Name (ARN) that is assigned to and uniquely identifies the GameLift resource that you want to assign tags to. GameLift resource ARNs are included in the data object for the resource, which can be retrieved by calling a List or Describe operation for the resource type.
", + "ListTagsForResourceRequest$ResourceARN": "The Amazon Resource Name (ARN) that is assigned to and uniquely identifies the GameLift resource that you want to retrieve tags for. GameLift resource ARNs are included in the data object for the resource, which can be retrieved by calling a List or Describe operation for the resource type.
", + "TagResourceRequest$ResourceARN": "The Amazon Resource Name (ARN) that is assigned to and uniquely identifies the GameLift resource that you want to assign tags to. GameLift resource ARNs are included in the data object for the resource, which can be retrieved by calling a List or Describe operation for the resource type.
", "UntagResourceRequest$ResourceARN": "The Amazon Resource Name (ARN) that is assigned to and uniquely identifies the GameLift resource that you want to remove tags from. GameLift resource ARNs are included in the data object for the resource, which can be retrieved by calling a List or Describe operation for the resource type.
" } }, + "AnywhereConfiguration": { + "base": "GameLift Anywhere configuration options for your Anywhere fleets.
", + "refs": { + "CreateFleetInput$AnywhereConfiguration": "GameLift Anywhere configuration options.
", + "FleetAttributes$AnywhereConfiguration": null, + "UpdateFleetAttributesInput$AnywhereConfiguration": "GameLift Anywhere configuration options.
" + } + }, "ArnStringModel": { "base": null, "refs": { @@ -172,7 +189,7 @@ "DescribeGameSessionsInput$GameSessionId": "A unique identifier for the game session to retrieve.
", "DescribePlayerSessionsInput$GameSessionId": "A unique identifier for the game session to retrieve player sessions for.
", "GameSessionConnectionInfo$GameSessionArn": "A unique identifier for the game session. Use the game session ID.
", - "GameSessionQueueDestination$DestinationArn": "The Amazon Resource Name (ARN) that is assigned to fleet or fleet alias. ARNs, which include a fleet ID or alias ID and a Region name, provide a unique identifier across all Regions.
", + "GameSessionQueueDestination$DestinationArn": "The Amazon Resource Name (ARN) that is assigned to fleet or fleet alias. ARNs, which include a fleet ID or alias ID and a Region name, provide a unique identifier across all Regions.
", "GetGameSessionLogUrlInput$GameSessionId": "A unique identifier for the game session to get logs for.
", "QueueArnsList$member": null, "StartMatchBackfillInput$GameSessionArn": "A unique identifier for the game session. Use the game session ID. When using FlexMatch as a standalone matchmaking solution, this parameter is not needed.
", @@ -180,7 +197,7 @@ } }, "AttributeValue": { - "base": "Values for use in Player attribute key-value pairs. This object lets you specify an attribute value using any of the valid data types: string, number, string array, or data map. Each AttributeValue object can use only one of the available properties.
Values for use in player attribute key-value pairs. This object lets you specify an attribute value using any of the valid data types: string, number, string array, or data map. Each AttributeValue object can use only one of the available properties.
Temporary access credentials used for uploading game build files to Amazon GameLift. They are valid for a limited time. If they expire before you upload your game build, get a new set by calling RequestUploadCredentials.
", + "base": "Temporary access credentials used for uploading game build files to Amazon GameLift. They are valid for a limited time. If they expire before you upload your game build, get a new set by calling RequestUploadCredentials.
", "refs": { - "CreateBuildOutput$UploadCredentials": "This element is returned only when the operation is called without a storage location. It contains credentials to use when you are uploading a build file to an Amazon S3 bucket that is owned by Amazon GameLift. Credentials have a limited life span. To refresh these credentials, call RequestUploadCredentials.
", + "CreateBuildOutput$UploadCredentials": "This element is returned only when the operation is called without a storage location. It contains credentials to use when you are uploading a build file to an Amazon S3 bucket that is owned by Amazon GameLift. Credentials have a limited life span. To refresh these credentials, call RequestUploadCredentials.
", + "GetComputeAccessOutput$Credentials": "The access credentials for the compute resource.
", "RequestUploadCredentialsOutput$UploadCredentials": "Amazon Web Services credentials required when uploading a game build to the storage location. These credentials have a limited lifespan and are valid only for the build they were issued for.
" } }, "BackfillMode": { "base": null, "refs": { - "CreateMatchmakingConfigurationInput$BackfillMode": "The method used to backfill game sessions that are created with this matchmaking configuration. Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have GameLift create a StartMatchBackfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch. Automatic backfill is not available when FlexMatchMode is set to STANDALONE.
The method used to backfill game sessions created with this matchmaking configuration. MANUAL indicates that the game makes backfill requests or does not use the match backfill feature. AUTOMATIC indicates that GameLift creates StartMatchBackfill requests whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill existing games with FlexMatch. Automatic backfill is not available when FlexMatchMode is set to STANDALONE.
The method that is used to backfill game sessions created with this matchmaking configuration. Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have GameLift create a StartMatchBackfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch. Automatic backfill is not available when FlexMatchMode is set to STANDALONE.
The method used to backfill game sessions that are created with this matchmaking configuration. Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have GameLift create a backfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch. Automatic backfill is not available when FlexMatchMode is set to STANDALONE.
The method used to backfill game sessions created with this matchmaking configuration. MANUAL indicates that the game makes backfill requests or does not use the match backfill feature. AUTOMATIC indicates that GameLift creates backfill requests whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill existing games with FlexMatch. Automatic backfill is not available when FlexMatchMode is set to STANDALONE.
The method that is used to backfill game sessions created with this matchmaking configuration. Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have GameLift create a match backfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch. Automatic backfill is not available when FlexMatchMode is set to STANDALONE.
Properties describing a custom game build.
Related actions
CreateBuild | ListBuilds | DescribeBuild | UpdateBuild | DeleteBuild | All APIs by task
", + "base": "Properties describing a custom game build.
", "refs": { "BuildList$member": null, "CreateBuildOutput$Build": "The newly created build resource, including a unique build IDs and status.
", @@ -235,7 +253,7 @@ "BuildArn": { "base": null, "refs": { - "Build$BuildArn": "The Amazon Resource Name (ARN) that is assigned to a GameLift build resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::build/build-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift build ARN, the resource ID matches the BuildId value.
The Amazon Resource Name (ARN) assigned to a GameLift build resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::build/build-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift build ARN, the resource ID matches the BuildId value.
The Amazon Resource Name (ARN) associated with the GameLift build resource that is deployed on instances in this fleet. In a GameLift build ARN, the resource ID matches the BuildId value.
Determines whether a TLS/SSL certificate is generated for a fleet. This feature must be enabled when creating the fleet. All instances in a fleet share the same certificate. The certificate can be retrieved by calling the GameLift Server SDK operation GetInstanceCertificate.
A fleet's certificate configuration is part of FleetAttributes.
", + "base": "Determines whether a TLS/SSL certificate is generated for a fleet. This feature must be enabled when creating the fleet. All instances in a fleet share the same certificate. The certificate can be retrieved by calling the GameLift Server SDK operation GetInstanceCertificate.
Prompts GameLift to generate a TLS/SSL certificate for the fleet. TLS certificates are used for encrypting traffic between game clients and the game servers that are running on GameLift. By default, the CertificateConfiguration is set to DISABLED. This property cannot be changed after the fleet is created.
Note: This feature requires the Amazon Web Services Certificate Manager (ACM) service, which is not available in all Amazon Web Services regions. When working in a region that does not support this feature, a fleet creation request with certificate generation fails with a 4xx error.
", - "FleetAttributes$CertificateConfiguration": "Indicates whether a TLS/SSL certificate was generated for the fleet.
" + "CreateFleetInput$CertificateConfiguration": "Prompts GameLift to generate a TLS/SSL certificate for the fleet. GameLift uses the certificates to encrypt traffic between game clients and the game servers running on GameLift. By default, the CertificateConfiguration is DISABLED. You can't change this property after you create the fleet.
Certificate Manager (ACM) certificates expire after 13 months. Certificate expiration can cause fleets to fail, preventing players from connecting to instances in the fleet. We recommend you replace fleets before 13 months, consider using fleet aliases for a smooth transition.
ACM isn't available in all Amazon Web Services regions. A fleet creation request with certificate generation enabled in an unsupported Region, fails with a 4xx error. For more information about the supported Regions, see Supported Regions in the Certificate Manager User Guide.
Comparison operator to use when measuring a metric against the threshold value.
" } }, + "Compute": { + "base": "Resources used to host your game servers. A compute resource can be managed GameLift Amazon EC2 instances or your own resources.
", + "refs": { + "ComputeList$member": null, + "DescribeComputeOutput$Compute": "The details of the compute resource you registered to the specified fleet.
", + "RegisterComputeOutput$Compute": "The details of the compute resource you registered to the specified fleet.
" + } + }, + "ComputeArn": { + "base": null, + "refs": { + "Compute$ComputeArn": "The ARN that is assigned to the compute resource and uniquely identifies it. ARNs are unique across locations.
", + "GetComputeAccessOutput$ComputeArn": "The Amazon Resource Name (ARN) that is assigned to a GameLift compute resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::compute/compute-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
The Amazon Resource Name (ARN) that is assigned to a GameLift compute resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::compute/compute-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912
The authorization token that your game server uses to authenticate with GameLift.
" + } + }, + "ComputeList": { + "base": null, + "refs": { + "ListComputeOutput$ComputeList": "A list of compute resources registered to the fleet you specified.
" + } + }, + "ComputeName": { + "base": null, + "refs": { + "Compute$ComputeName": "A descriptive label that is associated with the compute resource registered to your fleet.
", + "RegisterComputeInput$ComputeName": "A descriptive label that is associated with the compute resource registered to your fleet.
" + } + }, + "ComputeNameOrArn": { + "base": null, + "refs": { + "DeregisterComputeInput$ComputeName": "The name of the compute resource you want to delete.
", + "DescribeComputeInput$ComputeName": "A descriptive label that is associated with the compute resource registered to your fleet.
", + "GetComputeAccessInput$ComputeName": "The name of the compute resource you are requesting credentials for.
", + "GetComputeAccessOutput$ComputeName": "The name of the compute resource you requested credentials for.
", + "GetComputeAuthTokenInput$ComputeName": "The name of the compute resource you are requesting the authorization token for.
", + "GetComputeAuthTokenOutput$ComputeName": "The name of the compute resource you are requesting the authorization token for.
" + } + }, + "ComputeStatus": { + "base": null, + "refs": { + "Compute$ComputeStatus": "Current status of the compute. A compute must have an ACTIVE status to host game sessions.
The type of compute resource used to host your game servers. You can use your own compute resources with GameLift Anywhere or use Amazon EC2 instances with managed GameLift.
", + "FleetAttributes$ComputeType": "The type of compute resource used to host your game servers. You can use your own compute resources with GameLift Anywhere or use Amazon EC2 instances with managed GameLift.
" + } + }, "ConflictException": { - "base": "The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
", + "base": "The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
", "refs": { } }, "CreateAliasInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "CreateAliasOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "CreateBuildInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "CreateBuildOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "CreateFleetInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "CreateFleetLocationsInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "CreateFleetLocationsOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "CreateFleetOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, @@ -356,62 +433,72 @@ } }, "CreateGameSessionInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "CreateGameSessionOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "CreateGameSessionQueueInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "CreateGameSessionQueueOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, + "refs": { + } + }, + "CreateLocationInput": { + "base": null, + "refs": { + } + }, + "CreateLocationOutput": { + "base": null, "refs": { } }, "CreateMatchmakingConfigurationInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "CreateMatchmakingConfigurationOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "CreateMatchmakingRuleSetInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "CreateMatchmakingRuleSetOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "CreatePlayerSessionInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "CreatePlayerSessionOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "CreatePlayerSessionsInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "CreatePlayerSessionsOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, @@ -426,17 +513,17 @@ } }, "CreateVpcPeeringAuthorizationInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "CreateVpcPeeringAuthorizationOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "CreateVpcPeeringConnectionInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, @@ -453,28 +540,40 @@ "UpdateMatchmakingConfigurationInput$CustomEventData": "Information to add to all events related to the matchmaking configuration.
" } }, + "CustomInputLocationStringModel": { + "base": null, + "refs": { + "CreateLocationInput$LocationName": "A descriptive name for the custom location.
" + } + }, + "CustomLocationNameOrArnModel": { + "base": null, + "refs": { + "DeleteLocationInput$LocationName": "The location name of the custom location to be deleted.
" + } + }, "DeleteAliasInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "DeleteBuildInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "DeleteFleetInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "DeleteFleetLocationsInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "DeleteFleetLocationsOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, @@ -489,7 +588,7 @@ } }, "DeleteGameSessionQueueInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, @@ -498,8 +597,18 @@ "refs": { } }, + "DeleteLocationInput": { + "base": null, + "refs": { + } + }, + "DeleteLocationOutput": { + "base": null, + "refs": { + } + }, "DeleteMatchmakingConfigurationInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, @@ -509,17 +618,17 @@ } }, "DeleteMatchmakingRuleSetInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "DeleteMatchmakingRuleSetOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "DeleteScalingPolicyInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, @@ -529,7 +638,7 @@ } }, "DeleteVpcPeeringAuthorizationInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, @@ -539,7 +648,7 @@ } }, "DeleteVpcPeeringConnectionInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, @@ -548,118 +657,138 @@ "refs": { } }, + "DeregisterComputeInput": { + "base": null, + "refs": { + } + }, + "DeregisterComputeOutput": { + "base": null, + "refs": { + } + }, "DeregisterGameServerInput": { "base": null, "refs": { } }, "DescribeAliasInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "DescribeAliasOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "DescribeBuildInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "DescribeBuildOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, + "refs": { + } + }, + "DescribeComputeInput": { + "base": null, + "refs": { + } + }, + "DescribeComputeOutput": { + "base": null, "refs": { } }, "DescribeEC2InstanceLimitsInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "DescribeEC2InstanceLimitsOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "DescribeFleetAttributesInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "DescribeFleetAttributesOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "DescribeFleetCapacityInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "DescribeFleetCapacityOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "DescribeFleetEventsInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "DescribeFleetEventsOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "DescribeFleetLocationAttributesInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "DescribeFleetLocationAttributesOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "DescribeFleetLocationCapacityInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "DescribeFleetLocationCapacityOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "DescribeFleetLocationUtilizationInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "DescribeFleetLocationUtilizationOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "DescribeFleetPortSettingsInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "DescribeFleetPortSettingsOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "DescribeFleetUtilizationInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "DescribeFleetUtilizationOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, @@ -694,112 +823,112 @@ } }, "DescribeGameSessionDetailsInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "DescribeGameSessionDetailsOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "DescribeGameSessionPlacementInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "DescribeGameSessionPlacementOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "DescribeGameSessionQueuesInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "DescribeGameSessionQueuesOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "DescribeGameSessionsInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "DescribeGameSessionsOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "DescribeInstancesInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "DescribeInstancesOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "DescribeMatchmakingConfigurationsInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "DescribeMatchmakingConfigurationsOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "DescribeMatchmakingInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "DescribeMatchmakingOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "DescribeMatchmakingRuleSetsInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "DescribeMatchmakingRuleSetsOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "DescribePlayerSessionsInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "DescribePlayerSessionsOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "DescribeRuntimeConfigurationInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "DescribeRuntimeConfigurationOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "DescribeScalingPoliciesInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "DescribeScalingPoliciesOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, @@ -824,17 +953,17 @@ } }, "DescribeVpcPeeringConnectionsInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "DescribeVpcPeeringConnectionsOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "DesiredPlayerSession": { - "base": "Player information for use when creating player sessions using a game session placement request with StartGameSessionPlacement.
", + "base": "Player information for use when creating player sessions using a game session placement request.
", "refs": { "DesiredPlayerSessionList$member": null } @@ -848,6 +977,7 @@ "DnsName": { "base": null, "refs": { + "Compute$DnsName": "The DNS name of the compute resource. GameLift requires the DNS name or IP address to manage your compute resource.
", "GameSession$DnsName": "The DNS identifier assigned to the instance that is running the game session. Values have the following format:
TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.
Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)
When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.
", "GameSessionConnectionInfo$DnsName": "The DNS identifier assigned to the instance that is running the game session. Values have the following format:
TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.
Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)
When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.
", "GameSessionPlacement$DnsName": "The DNS identifier assigned to the instance that is running the game session. Values have the following format:
TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.
Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)
When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.
", @@ -855,6 +985,12 @@ "PlayerSession$DnsName": "The DNS identifier assigned to the instance that is running the game session. Values have the following format:
TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.
Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)
When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.
" } }, + "DnsNameInput": { + "base": null, + "refs": { + "RegisterComputeInput$DnsName": "The DNS name of the compute resource. GameLift requires the DNS name or IP address to manage your compute resource.
" + } + }, "Double": { "base": null, "refs": { @@ -867,17 +1003,17 @@ "base": null, "refs": { "AttributeValue$N": "For number values, expressed as double.
", - "StringDoubleMap$value": null + "PlayerAttributeStringDoubleMap$value": null } }, "EC2InstanceCounts": { - "base": "Resource capacity settings. Fleet capacity is measured in Amazon EC2 instances. Pending and terminating counts are non-zero when the fleet capacity is adjusting to a scaling event or if access to resources is temporarily affected.
EC2 instance counts are part of FleetCapacity.
", + "base": "Resource capacity settings. Fleet capacity is measured in Amazon EC2 instances. Pending and terminating counts are non-zero when the fleet capacity is adjusting to a scaling event or if access to resources is temporarily affected.
", "refs": { - "FleetCapacity$InstanceCounts": "The current instance count and capacity settings for the fleet location.
" + "FleetCapacity$InstanceCounts": null } }, "EC2InstanceLimit": { - "base": "The GameLift service limits for an Amazon EC2 instance type and current utilization. GameLift allows Amazon Web Services accounts a maximum number of instances, per instance type, per Amazon Web Services Region or location, for use with GameLift. You can request an limit increase for your account by using the Service limits page in the GameLift console.
Related actions
", + "base": "The GameLift service limits for an Amazon EC2 instance type and current utilization. GameLift allows Amazon Web Services accounts a maximum number of instances, per instance type, per Amazon Web Services Region or location, for use with GameLift. You can request an limit increase for your account by using the Service limits page in the GameLift console.
", "refs": { "EC2InstanceLimitList$member": null } @@ -891,6 +1027,7 @@ "EC2InstanceType": { "base": null, "refs": { + "Compute$Type": "Which compute type that the fleet uses. A fleet can use Anywhere compute resources owned by you or managed Amazon EC2 instances.
", "CreateFleetInput$EC2InstanceType": "The GameLift-supported Amazon EC2 instance type to use for all fleet instances. Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions of Amazon EC2 instance types.
", "DescribeEC2InstanceLimitsInput$EC2InstanceType": "Name of an Amazon EC2 instance type that is supported in GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Do not specify a value for this parameter to retrieve limits for all instance types.
", "EC2InstanceLimit$EC2InstanceType": "The name of an Amazon EC2 instance type. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions.
", @@ -900,7 +1037,7 @@ } }, "Event": { - "base": "Log entry describing an event that involves GameLift resources (such as a fleet). In addition to tracking activity, event codes and messages can provide additional information for troubleshooting and debugging problems.
Related actions
", + "base": "Log entry describing an event that involves GameLift resources (such as a fleet). In addition to tracking activity, event codes and messages can provide additional information for troubleshooting and debugging problems.
", "refs": { "EventList$member": null } @@ -908,7 +1045,7 @@ "EventCode": { "base": null, "refs": { - "Event$EventCode": "The type of event being logged.
Fleet state transition events:
FLEET_CREATED -- A fleet resource was successfully created with a status of NEW. Event messaging includes the fleet ID.
FLEET_STATE_DOWNLOADING -- Fleet status changed from NEW to DOWNLOADING. The compressed build has started downloading to a fleet instance for installation.
FLEET_STATE_VALIDATING -- Fleet status changed from DOWNLOADING to VALIDATING. GameLift has successfully downloaded the build and is now validating the build files.
FLEET_STATE_BUILDING -- Fleet status changed from VALIDATING to BUILDING. GameLift has successfully verified the build files and is now running the installation scripts.
FLEET_STATE_ACTIVATING -- Fleet status changed from BUILDING to ACTIVATING. GameLift is trying to launch an instance and test the connectivity between the build and the GameLift Service via the Server SDK.
FLEET_STATE_ACTIVE -- The fleet's status changed from ACTIVATING to ACTIVE. The fleet is now ready to host game sessions.
FLEET_STATE_ERROR -- The Fleet's status changed to ERROR. Describe the fleet event message for more details.
Fleet creation events (ordered by fleet creation activity):
FLEET_BINARY_DOWNLOAD_FAILED -- The build failed to download to the fleet instance.
FLEET_CREATION_EXTRACTING_BUILD -- The game server build was successfully downloaded to an instance, and the build files are now being extracted from the uploaded build and saved to an instance. Failure at this stage prevents a fleet from moving to ACTIVE status. Logs for this stage display a list of the files that are extracted and saved on the instance. Access the logs by using the URL in PreSignedLogUrl.
FLEET_CREATION_RUNNING_INSTALLER -- The game server build files were successfully extracted, and the GameLift is now running the build's install script (if one is included). Failure in this stage prevents a fleet from moving to ACTIVE status. Logs for this stage list the installation steps and whether or not the install completed successfully. Access the logs by using the URL in PreSignedLogUrl.
FLEET_CREATION_VALIDATING_RUNTIME_CONFIG -- The build process was successful, and the GameLift is now verifying that the game server launch paths, which are specified in the fleet's runtime configuration, exist. If any listed launch path exists, GameLift tries to launch a game server process and waits for the process to report ready. Failures in this stage prevent a fleet from moving to ACTIVE status. Logs for this stage list the launch paths in the runtime configuration and indicate whether each is found. Access the logs by using the URL in PreSignedLogUrl.
FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND -- Validation of the runtime configuration failed because the executable specified in a launch path does not exist on the instance.
FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE -- Validation of the runtime configuration failed because the executable specified in a launch path failed to run on the fleet instance.
FLEET_VALIDATION_TIMED_OUT -- Validation of the fleet at the end of creation timed out. Try fleet creation again.
FLEET_ACTIVATION_FAILED -- The fleet failed to successfully complete one of the steps in the fleet activation process. This event code indicates that the game build was successfully downloaded to a fleet instance, built, and validated, but was not able to start a server process. For more information, see Debug Fleet Creation Issues.
FLEET_ACTIVATION_FAILED_NO_INSTANCES -- Fleet creation was not able to obtain any instances based on the input fleet attributes. Try again at a different time or choose a different combination of fleet attributes such as fleet type, instance type, etc.
FLEET_INITIALIZATION_FAILED -- A generic exception occurred during fleet creation. Describe the fleet event message for more details.
VPC peering events:
FLEET_VPC_PEERING_SUCCEEDED -- A VPC peering connection has been established between the VPC for an GameLift fleet and a VPC in your Amazon Web Services account.
FLEET_VPC_PEERING_FAILED -- A requested VPC peering connection has failed. Event details and status information (see DescribeVpcPeeringConnections) provide additional detail. A common reason for peering failure is that the two VPCs have overlapping CIDR blocks of IPv4 addresses. To resolve this, change the CIDR block for the VPC in your Amazon Web Services account. For more information on VPC peering failures, see https://docs.aws.amazon.com/AmazonVPC/latest/PeeringGuide/invalid-peering-configurations.html
FLEET_VPC_PEERING_DELETED -- A VPC peering connection has been successfully deleted.
Spot instance events:
INSTANCE_INTERRUPTED -- A spot instance was interrupted by EC2 with a two-minute notification.
Spot process events:
SERVER_PROCESS_INVALID_PATH -- The game server executable or script could not be found based on the Fleet runtime configuration. Check that the launch path is correct based on the operating system of the Fleet.
SERVER_PROCESS_SDK_INITIALIZATION_TIMEOUT -- The server process did not call InitSDK() within the time expected. Check your game session log to see why InitSDK() was not called in time.
SERVER_PROCESS_PROCESS_READY_TIMEOUT -- The server process did not call ProcessReady() within the time expected after calling InitSDK(). Check your game session log to see why ProcessReady() was not called in time.
SERVER_PROCESS_CRASHED -- The server process exited without calling ProcessEnding(). Check your game session log to see why ProcessEnding() was not called.
SERVER_PROCESS_TERMINATED_UNHEALTHY -- The server process did not report a valid health check for too long and was therefore terminated by GameLift. Check your game session log to see if the thread became stuck processing a synchronous task for too long.
SERVER_PROCESS_FORCE_TERMINATED -- The server process did not exit cleanly after OnProcessTerminate() was sent within the time expected. Check your game session log to see why termination took longer than expected.
SERVER_PROCESS_PROCESS_EXIT_TIMEOUT -- The server process did not exit cleanly within the time expected after calling ProcessEnding(). Check your game session log to see why termination took longer than expected.
Game session events:
GAME_SESSION_ACTIVATION_TIMEOUT -- GameSession failed to activate within the expected time. Check your game session log to see why ActivateGameSession() took longer to complete than expected.
Other fleet events:
FLEET_SCALING_EVENT -- A change was made to the fleet's capacity settings (desired instances, minimum/maximum scaling limits). Event messaging includes the new capacity settings.
FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED -- A change was made to the fleet's game session protection policy setting. Event messaging includes both the old and new policy setting.
FLEET_DELETED -- A request to delete a fleet was initiated.
GENERIC_EVENT -- An unspecified event has occurred.
The type of event being logged.
Fleet state transition events:
FLEET_CREATED -- A fleet resource was successfully created with a status of NEW. Event messaging includes the fleet ID.
FLEET_STATE_DOWNLOADING -- Fleet status changed from NEW to DOWNLOADING. The compressed build has started downloading to a fleet instance for installation.
FLEET_STATE_VALIDATING -- Fleet status changed from DOWNLOADING to VALIDATING. GameLift has successfully downloaded the build and is now validating the build files.
FLEET_STATE_BUILDING -- Fleet status changed from VALIDATING to BUILDING. GameLift has successfully verified the build files and is now running the installation scripts.
FLEET_STATE_ACTIVATING -- Fleet status changed from BUILDING to ACTIVATING. GameLift is trying to launch an instance and test the connectivity between the build and the GameLift Service via the Server SDK.
FLEET_STATE_ACTIVE -- The fleet's status changed from ACTIVATING to ACTIVE. The fleet is now ready to host game sessions.
FLEET_STATE_ERROR -- The Fleet's status changed to ERROR. Describe the fleet event message for more details.
Fleet creation events (ordered by fleet creation activity):
FLEET_BINARY_DOWNLOAD_FAILED -- The build failed to download to the fleet instance.
FLEET_CREATION_EXTRACTING_BUILD -- The game server build was successfully downloaded to an instance, and the build files are now being extracted from the uploaded build and saved to an instance. Failure at this stage prevents a fleet from moving to ACTIVE status. Logs for this stage display a list of the files that are extracted and saved on the instance. Access the logs by using the URL in PreSignedLogUrl.
FLEET_CREATION_RUNNING_INSTALLER -- The game server build files were successfully extracted, and the GameLift is now running the build's install script (if one is included). Failure in this stage prevents a fleet from moving to ACTIVE status. Logs for this stage list the installation steps and whether or not the install completed successfully. Access the logs by using the URL in PreSignedLogUrl.
FLEET_CREATION_VALIDATING_RUNTIME_CONFIG -- The build process was successful, and the GameLift is now verifying that the game server launch paths, which are specified in the fleet's runtime configuration, exist. If any listed launch path exists, GameLift tries to launch a game server process and waits for the process to report ready. Failures in this stage prevent a fleet from moving to ACTIVE status. Logs for this stage list the launch paths in the runtime configuration and indicate whether each is found. Access the logs by using the URL in PreSignedLogUrl.
FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND -- Validation of the runtime configuration failed because the executable specified in a launch path does not exist on the instance.
FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE -- Validation of the runtime configuration failed because the executable specified in a launch path failed to run on the fleet instance.
FLEET_VALIDATION_TIMED_OUT -- Validation of the fleet at the end of creation timed out. Try fleet creation again.
FLEET_ACTIVATION_FAILED -- The fleet failed to successfully complete one of the steps in the fleet activation process. This event code indicates that the game build was successfully downloaded to a fleet instance, built, and validated, but was not able to start a server process. For more information, see Debug Fleet Creation Issues.
FLEET_ACTIVATION_FAILED_NO_INSTANCES -- Fleet creation was not able to obtain any instances based on the input fleet attributes. Try again at a different time or choose a different combination of fleet attributes such as fleet type, instance type, etc.
FLEET_INITIALIZATION_FAILED -- A generic exception occurred during fleet creation. Describe the fleet event message for more details.
VPC peering events:
FLEET_VPC_PEERING_SUCCEEDED -- A VPC peering connection has been established between the VPC for an GameLift fleet and a VPC in your Amazon Web Services account.
FLEET_VPC_PEERING_FAILED -- A requested VPC peering connection has failed. Event details and status information provide additional detail. A common reason for peering failure is that the two VPCs have overlapping CIDR blocks of IPv4 addresses. To resolve this, change the CIDR block for the VPC in your Amazon Web Services account. For more information on VPC peering failures, see https://docs.aws.amazon.com/AmazonVPC/latest/PeeringGuide/invalid-peering-configurations.html
FLEET_VPC_PEERING_DELETED -- A VPC peering connection has been successfully deleted.
Spot instance events:
INSTANCE_INTERRUPTED -- A spot instance was interrupted by EC2 with a two-minute notification.
Server process events:
SERVER_PROCESS_INVALID_PATH -- The game server executable or script could not be found based on the Fleet runtime configuration. Check that the launch path is correct based on the operating system of the Fleet.
SERVER_PROCESS_SDK_INITIALIZATION_TIMEOUT -- The server process did not call InitSDK() within the time expected. Check your game session log to see why InitSDK() was not called in time.
SERVER_PROCESS_PROCESS_READY_TIMEOUT -- The server process did not call ProcessReady() within the time expected after calling InitSDK(). Check your game session log to see why ProcessReady() was not called in time.
SERVER_PROCESS_CRASHED -- The server process exited without calling ProcessEnding(). Check your game session log to see why ProcessEnding() was not called.
SERVER_PROCESS_TERMINATED_UNHEALTHY -- The server process did not report a valid health check for too long and was therefore terminated by GameLift. Check your game session log to see if the thread became stuck processing a synchronous task for too long.
SERVER_PROCESS_FORCE_TERMINATED -- The server process did not exit cleanly after OnProcessTerminate() was sent within the time expected. Check your game session log to see why termination took longer than expected.
SERVER_PROCESS_PROCESS_EXIT_TIMEOUT -- The server process did not exit cleanly within the time expected after calling ProcessEnding(). Check your game session log to see why termination took longer than expected.
Game session events:
GAME_SESSION_ACTIVATION_TIMEOUT -- GameSession failed to activate within the expected time. Check your game session log to see why ActivateGameSession() took longer to complete than expected.
Other fleet events:
FLEET_SCALING_EVENT -- A change was made to the fleet's capacity settings (desired instances, minimum/maximum scaling limits). Event messaging includes the new capacity settings.
FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED -- A change was made to the fleet's game session protection policy setting. Event messaging includes both the old and new policy setting.
FLEET_DELETED -- A request to delete a fleet was initiated.
GENERIC_EVENT -- An unspecified event has occurred.
A list of fleet locations where a game session queue can place new game sessions. You can use a filter to temporarily turn off placements for specific locations. For queues that have multi-location fleets, you can use a filter configuration allow placement with some, but not all of these locations.
Filter configurations are part of a GameSessionQueue.
", + "base": "A list of fleet locations where a game session queue can place new game sessions. You can use a filter to temporarily turn off placements for specific locations. For queues that have multi-location fleets, you can use a filter configuration allow placement with some, but not all of these locations.
", "refs": { "CreateGameSessionQueueInput$FilterConfiguration": "A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of Amazon Web Services Region codes, such as us-west-2. If this parameter is not set, game sessions can be placed in any queue location.
A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of Amazon Web Services Region codes, such as us-west-2. If this parameter is not set, game sessions can be placed in any queue location.
A list of fleet activity that has been suspended using StopFleetActions. This includes fleet auto-scaling.
", + "FleetAttributes$StoppedActions": "A list of fleet activity that has been suspended using StopFleetActions . This includes fleet auto-scaling.
", "LocationAttributes$StoppedActions": "A list of fleet actions that have been suspended in the fleet location.
", "StartFleetActionsInput$Actions": "List of actions to restart on the fleet.
", "StopFleetActionsInput$Actions": "List of actions to suspend on the fleet.
" @@ -943,26 +1080,31 @@ "FleetArn": { "base": null, "refs": { + "Compute$FleetArn": "The Amazon Resource Name (ARN) of the fleet that the compute is registered to.
", "CreateFleetLocationsOutput$FleetArn": "The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift fleet ARN, the resource ID matches the FleetId value.
The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
The Amazon Resource Name (ARN) associated with the GameLift fleet that this game session is running on.
", + "GetComputeAccessOutput$FleetArn": "The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
The Amazon Resource Name (ARN) associated with the GameLift fleet that the player's game session is running on.
", "ResolveAliasOutput$FleetArn": "The Amazon Resource Name (ARN) associated with the GameLift fleet resource that this alias points to.
", "ScalingPolicy$FleetArn": "The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
The Amazon Resource Name (ARN) associated with the GameLift fleet resource for this connection.
" + "UpdateFleetPortSettingsOutput$FleetArn": "The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
The Amazon Resource Name (ARN) associated with the GameLift fleet resource for this connection.
" } }, "FleetAttributes": { - "base": "Describes a GameLift fleet of game hosting resources.
Related actions
CreateFleet | DescribeFleetAttributes
", + "base": "Describes a GameLift fleet of game hosting resources.
Related actions
", "refs": { "CreateFleetOutput$FleetAttributes": "The properties for the new fleet, including the current status. All fleets are placed in NEW status on creation.
A unique identifier for the fleet that the compute is registered to.
", "CreateVpcPeeringConnectionInput$FleetId": "A unique identifier for the fleet. You can use either the fleet ID or ARN value. This tells Amazon GameLift which GameLift VPC to peer with.
", "DeleteVpcPeeringConnectionInput$FleetId": "A unique identifier for the fleet. This fleet specified must match the fleet referenced in the VPC peering connection record. You can use either the fleet ID or ARN value.
", "DescribeFleetPortSettingsOutput$FleetId": "A unique identifier for the fleet that was requested.
", @@ -1021,7 +1164,7 @@ "FleetIdList": { "base": null, "refs": { - "ListFleetsOutput$FleetIds": "A set of fleet IDs that match the list request. You can retrieve additional information about all returned fleets by passing this result set to a DescribeFleetAttributes, DescribeFleetCapacity, or DescribeFleetUtilization call.
" + "ListFleetsOutput$FleetIds": "A set of fleet IDs that match the list request.
" } }, "FleetIdOrArn": { @@ -1034,6 +1177,8 @@ "DeleteFleetLocationsInput$FleetId": "A unique identifier for the fleet to delete locations for. You can use either the fleet ID or ARN value.
", "DeleteFleetLocationsOutput$FleetId": "A unique identifier for the fleet that location attributes are being deleted for.
", "DeleteScalingPolicyInput$FleetId": "A unique identifier for the fleet to be deleted. You can use either the fleet ID or ARN value.
", + "DeregisterComputeInput$FleetId": ">A unique identifier for the fleet the compute resource is registered to.
", + "DescribeComputeInput$FleetId": "A unique identifier for the fleet the compute is registered to.
", "DescribeFleetEventsInput$FleetId": "A unique identifier for the fleet to get event logs for. You can use either the fleet ID or ARN value.
", "DescribeFleetLocationAttributesInput$FleetId": "A unique identifier for the fleet to retrieve remote locations for. You can use either the fleet ID or ARN value.
", "DescribeFleetLocationAttributesOutput$FleetId": "A unique identifier for the fleet that location attributes were requested for.
", @@ -1046,8 +1191,14 @@ "DescribeRuntimeConfigurationInput$FleetId": "A unique identifier for the fleet to get the runtime configuration for. You can use either the fleet ID or ARN value.
", "DescribeScalingPoliciesInput$FleetId": "A unique identifier for the fleet for which to retrieve scaling policies. You can use either the fleet ID or ARN value.
", "FleetIdOrArnList$member": null, + "GetComputeAccessInput$FleetId": "A unique identifier for the fleet that the compute resource is registered to.
", + "GetComputeAccessOutput$FleetId": "The fleet ID of compute resource.
", + "GetComputeAuthTokenInput$FleetId": "A unique identifier for the fleet that the compute is registered to.
", + "GetComputeAuthTokenOutput$FleetId": "A unique identifier for the fleet that the compute is registered to.
", "GetInstanceAccessInput$FleetId": "A unique identifier for the fleet that contains the instance you want access to. You can use either the fleet ID or ARN value. The fleet can be in any of the following statuses: ACTIVATING, ACTIVE, or ERROR. Fleets with an ERROR status may be accessible for a short time before they are deleted.
A unique identifier for the fleet the compute resources are registered to.
", "PutScalingPolicyInput$FleetId": "A unique identifier for the fleet to apply this policy to. You can use either the fleet ID or ARN value. The fleet cannot be in any of the following statuses: ERROR or DELETING.
", + "RegisterComputeInput$FleetId": "A unique identifier for the fleet to register the compute to. You can use either the fleet ID or ARN value.
", "SearchGameSessionsInput$FleetId": "A unique identifier for the fleet to search for active game sessions. You can use either the fleet ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.
", "StartFleetActionsInput$FleetId": "A unique identifier for the fleet to restart actions on. You can use either the fleet ID or ARN value.
", "StopFleetActionsInput$FleetId": "A unique identifier for the fleet to stop actions on. You can use either the fleet ID or ARN value.
", @@ -1061,8 +1212,8 @@ "base": null, "refs": { "DescribeFleetAttributesInput$FleetIds": "A list of unique fleet identifiers to retrieve attributes for. You can use either the fleet ID or ARN value. To retrieve attributes for all current fleets, do not include this parameter.
", - "DescribeFleetCapacityInput$FleetIds": "A unique identifier for the fleet(s) to retrieve capacity information for. You can use either the fleet ID or ARN value. Leave this parameter empty to retrieve capacity information for all fleets.
", - "DescribeFleetUtilizationInput$FleetIds": "A unique identifier for the fleet(s) to retrieve utilization data for. You can use either the fleet ID or ARN value. To retrieve attributes for all current fleets, do not include this parameter.
" + "DescribeFleetCapacityInput$FleetIds": "A unique identifier for the fleet to retrieve capacity information for. You can use either the fleet ID or ARN value. Leave this parameter empty to retrieve capacity information for all fleets.
", + "DescribeFleetUtilizationInput$FleetIds": "A unique identifier for the fleet to retrieve utilization data for. You can use either the fleet ID or ARN value. To retrieve attributes for all current fleets, do not include this parameter.
" } }, "FleetStatus": { @@ -1076,11 +1227,11 @@ "base": null, "refs": { "CreateFleetInput$FleetType": "Indicates whether to use On-Demand or Spot instances for this fleet. By default, this property is set to ON_DEMAND. Learn more about when to use On-Demand versus Spot Instances. This property cannot be changed after the fleet is created.
The kind of instances, On-Demand or Spot, that this fleet uses.
" + "FleetAttributes$FleetType": "Indicates whether to use On-Demand or Spot instances for this fleet. By default, this property is set to ON_DEMAND. Learn more about when to use On-Demand versus Spot Instances. This property cannot be changed after the fleet is created.
Current resource utilization statistics in a specified fleet or location. The location value might refer to a fleet's remote location or its home Region.
Related actions
DescribeFleetUtilization | DescribeFleetLocationUtilization
", + "base": "Current resource utilization statistics in a specified fleet or location. The location value might refer to a fleet's remote location or its home Region.
Related actions
", "refs": { "DescribeFleetLocationUtilizationOutput$FleetUtilization": "Utilization information for the requested fleet location. Utilization objects are returned only for fleets and locations that currently exist.
", "FleetUtilizationList$member": null @@ -1110,11 +1261,17 @@ "base": null, "refs": { "Alias$Description": "A human-readable description of an alias.
", - "Build$Name": "A descriptive label that is associated with a build. Build names do not need to be unique. It can be set using CreateBuild or UpdateBuild.
", - "Build$Version": "Version information that is associated with a build or script. Version strings do not need to be unique. This value can be set using CreateBuild or UpdateBuild.
", + "Build$Name": "A descriptive label associated with a build. Build names do not need to be unique. It can be set using CreateBuild or UpdateBuild.
", + "Build$Version": "Version information associated with a build or script. Version strings do not need to be unique.
", "RoutingStrategy$Message": "The message text to be used with a terminal routing strategy.
" } }, + "GameLiftServiceSdkEndpointOutput": { + "base": null, + "refs": { + "Compute$GameLiftServiceSdkEndpoint": "The endpoint connection details of the GameLift SDK endpoint that your game server connects to.
" + } + }, "GameProperty": { "base": "Set of key-value pairs that contain information about a game session. When included in a game session request, these properties communicate details to be used when setting up the new game session. For example, a game property might specify a game mode, level, or map. Game properties are passed to the game server process when initiating a new game session. For more information, see the GameLift Developer Guide.
", "refs": { @@ -1130,13 +1287,13 @@ "GamePropertyList": { "base": null, "refs": { - "CreateGameSessionInput$GameProperties": "A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).
", - "CreateMatchmakingConfigurationInput$GameProperties": "A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match. This parameter is not used if FlexMatchMode is set to STANDALONE.
A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). You can search for active game sessions based on this custom data with SearchGameSessions.
", - "GameSessionPlacement$GameProperties": "A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).
", - "MatchmakingConfiguration$GameProperties": "A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match. This parameter is not used when FlexMatchMode is set to STANDALONE.
A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).
", - "UpdateMatchmakingConfigurationInput$GameProperties": "A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match. This parameter is not used if FlexMatchMode is set to STANDALONE.
A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process with a request to start a new game session (see Start a Game Session).
", + "CreateMatchmakingConfigurationInput$GameProperties": "A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match. This parameter is not used if FlexMatchMode is set to STANDALONE.
A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process with a request to start a new game session (see Start a Game Session).
", + "GameSessionPlacement$GameProperties": "A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process with a request to start a new game session (see Start a Game Session).
", + "MatchmakingConfiguration$GameProperties": "A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match. This parameter is not used when FlexMatchMode is set to STANDALONE.
A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process with a request to start a new game session (see Start a Game Session).
", + "UpdateMatchmakingConfigurationInput$GameProperties": "A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match. This parameter is not used if FlexMatchMode is set to STANDALONE.
This data type is used with the GameLift FleetIQ and game server groups.
Properties describing a game server that is running on an instance in a GameServerGroup.
A game server is created by a successful call to RegisterGameServer and deleted by calling DeregisterGameServer. A game server is claimed to host a game session by calling ClaimGameServer.
Related actions
RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer | UpdateGameServer | DeregisterGameServer | All APIs by task
", + "base": "This data type is used with the GameLift FleetIQ and game server groups.
Properties describing a game server that is running on an instance in a game server group.
A game server is created by a successful call to RegisterGameServer and deleted by calling DeregisterGameServer. A game server is claimed to host a game session by calling ClaimGameServer.
Object that describes the newly claimed game server.
", "DescribeGameServerOutput$GameServer": "Object that describes the requested game server.
", @@ -1171,14 +1328,14 @@ "GameServerData": { "base": null, "refs": { - "ClaimGameServerInput$GameServerData": "A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers using ListGameServers or ClaimGameServer.
", - "GameServer$GameServerData": "A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers using ListGameServers or ClaimGameServer.
", - "RegisterGameServerInput$GameServerData": "A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers using ListGameServers or ClaimGameServer.
", - "UpdateGameServerInput$GameServerData": "A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers using ListGameServers or ClaimGameServer.
" + "ClaimGameServerInput$GameServerData": "A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers.
", + "GameServer$GameServerData": "A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers.
", + "RegisterGameServerInput$GameServerData": "A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers.
", + "UpdateGameServerInput$GameServerData": "A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers.
" } }, "GameServerGroup": { - "base": "This data type is used with the GameLift FleetIQ and game server groups.
Properties that describe a game server group resource. A game server group manages certain properties related to a corresponding Amazon EC2 Auto Scaling group.
A game server group is created by a successful call to CreateGameServerGroup and deleted by calling DeleteGameServerGroup. Game server group activity can be temporarily suspended and resumed by calling SuspendGameServerGroup and ResumeGameServerGroup, respectively.
Related actions
CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup | SuspendGameServerGroup | DescribeGameServerInstances | All APIs by task
", + "base": "This data type is used with the GameLift FleetIQ and game server groups.
Properties that describe a game server group resource. A game server group manages certain properties related to a corresponding Amazon EC2 Auto Scaling group.
A game server group is created by a successful call to CreateGameServerGroup and deleted by calling DeleteGameServerGroup. Game server group activity can be temporarily suspended and resumed by calling SuspendGameServerGroup and ResumeGameServerGroup, respectively.
The newly created game server group object, including the new ARN value for the GameLift FleetIQ game server group and the object's status. The Amazon EC2 Auto Scaling group ARN is initially null, since the group has not yet been created. This value is added once the game server group status reaches ACTIVE.
An object that describes the deleted game server group resource, with status updated to DELETE_SCHEDULED.
This data type is used with the GameLift FleetIQ and game server groups.
Configuration settings for intelligent automatic scaling that uses target tracking. These settings are used to add an Auto Scaling policy when creating the corresponding Auto Scaling group with CreateGameServerGroup. After the Auto Scaling group is created, all updates to Auto Scaling policies, including changing this policy and adding or removing other policies, is done directly on the Auto Scaling group.
", + "base": "This data type is used with the GameLift FleetIQ and game server groups.
Configuration settings for intelligent automatic scaling that uses target tracking. These settings are used to add an Auto Scaling policy when creating the corresponding Auto Scaling group. After the Auto Scaling group is created, all updates to Auto Scaling policies, including changing this policy and adding or removing other policies, is done directly on the Auto Scaling group.
", "refs": { "CreateGameServerGroupInput$AutoScalingPolicy": "Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. The scaling policy uses the metric \"PercentUtilizedGameServers\" to maintain a buffer of idle game servers that can immediately accommodate new games and players. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the Amazon Web Services console or APIs.
An identifier for the new game server group. This value is used to generate unique ARN identifiers for the Amazon EC2 Auto Scaling group and the GameLift FleetIQ game server group. The name must be unique per Region per Amazon Web Services account.
", - "GameServer$GameServerGroupName": "A unique identifier for the game server group where the game server is running. Use either the GameServerGroup name or ARN value.
", + "GameServer$GameServerGroupName": "A unique identifier for the game server group where the game server is running.
", "GameServerGroup$GameServerGroupName": "A developer-defined identifier for the game server group. The name is unique for each Region in each Amazon Web Services account.
", "GameServerInstance$GameServerGroupName": "A developer-defined identifier for the game server group that includes the game server instance. The name is unique for each Region in each Amazon Web Services account.
" } @@ -1241,18 +1398,18 @@ "GameServerGroupNameOrArn": { "base": null, "refs": { - "ClaimGameServerInput$GameServerGroupName": "A unique identifier for the game server group where the game server is running. Use either the GameServerGroup name or ARN value. If you are not specifying a game server to claim, this value identifies where you want GameLift FleetIQ to look for an available game server to claim.
", - "DeleteGameServerGroupInput$GameServerGroupName": "A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.
", - "DeregisterGameServerInput$GameServerGroupName": "A unique identifier for the game server group where the game server is running. Use either the GameServerGroup name or ARN value.
", - "DescribeGameServerGroupInput$GameServerGroupName": "A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.
", - "DescribeGameServerInput$GameServerGroupName": "A unique identifier for the game server group where the game server is running. Use either the GameServerGroup name or ARN value.
", - "DescribeGameServerInstancesInput$GameServerGroupName": "A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.
", - "ListGameServersInput$GameServerGroupName": "An identifier for the game server group to retrieve a list of game servers from. Use either the GameServerGroup name or ARN value.
", - "RegisterGameServerInput$GameServerGroupName": "A unique identifier for the game server group where the game server is running. Use either the GameServerGroup name or ARN value.
", - "ResumeGameServerGroupInput$GameServerGroupName": "A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.
", - "SuspendGameServerGroupInput$GameServerGroupName": "A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.
", - "UpdateGameServerGroupInput$GameServerGroupName": "A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.
", - "UpdateGameServerInput$GameServerGroupName": "A unique identifier for the game server group where the game server is running. Use either the GameServerGroup name or ARN value.
" + "ClaimGameServerInput$GameServerGroupName": "A unique identifier for the game server group where the game server is running. If you are not specifying a game server to claim, this value identifies where you want GameLift FleetIQ to look for an available game server to claim.
", + "DeleteGameServerGroupInput$GameServerGroupName": "A unique identifier for the game server group. Use either the name or ARN value.
", + "DeregisterGameServerInput$GameServerGroupName": "A unique identifier for the game server group where the game server is running.
", + "DescribeGameServerGroupInput$GameServerGroupName": "A unique identifier for the game server group. Use either the name or ARN value.
", + "DescribeGameServerInput$GameServerGroupName": "A unique identifier for the game server group where the game server is running.
", + "DescribeGameServerInstancesInput$GameServerGroupName": "A unique identifier for the game server group. Use either the name or ARN value.
", + "ListGameServersInput$GameServerGroupName": "An identifier for the game server group to retrieve a list of game servers from. Use either the name or ARN value.
", + "RegisterGameServerInput$GameServerGroupName": "A unique identifier for the game server group where the game server is running.
", + "ResumeGameServerGroupInput$GameServerGroupName": "A unique identifier for the game server group. Use either the name or ARN value.
", + "SuspendGameServerGroupInput$GameServerGroupName": "A unique identifier for the game server group. Use either the name or ARN value.
", + "UpdateGameServerGroupInput$GameServerGroupName": "A unique identifier for the game server group. Use either the name or ARN value.
", + "UpdateGameServerInput$GameServerGroupName": "A unique identifier for the game server group where the game server is running.
" } }, "GameServerGroupStatus": { @@ -1264,7 +1421,7 @@ "GameServerGroups": { "base": null, "refs": { - "ListGameServerGroupsOutput$GameServerGroups": "A collection of game server group objects that match the request.
" + "ListGameServerGroupsOutput$GameServerGroups": "The game server groups' game server groups.
" } }, "GameServerHealthCheck": { @@ -1285,7 +1442,7 @@ } }, "GameServerInstance": { - "base": "This data type is used with the GameLift FleetIQ and game server groups.
Additional properties, including status, that describe an EC2 instance in a game server group. Instance configurations are set with game server group properties (see DescribeGameServerGroup and with the EC2 launch template that was used when creating the game server group.
Retrieve game server instances for a game server group by calling DescribeGameServerInstances.
Related actions
CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup | SuspendGameServerGroup | DescribeGameServerInstances | All APIs by task
", + "base": "This data type is used with the GameLift FleetIQ and game server groups.
Additional properties, including status, that describe an EC2 instance in a game server group. Instance configurations are set with game server group properties (see DescribeGameServerGroup and with the EC2 launch template that was used when creating the game server group.
Retrieve game server instances for a game server group by calling DescribeGameServerInstances.
Current status of the game server instance.
ACTIVE -- The instance is viable for hosting game servers.
DRAINING -- The instance is not viable for hosting game servers. Existing game servers are in the process of ending, and new game servers are not started on this instance unless no other resources are available. When the instance is put in DRAINING, a new instance is started up to replace it. Once the instance has no UTILIZED game servers, it will be terminated in favor of the new instance.
SPOT_TERMINATING -- The instance is in the process of shutting down due to a Spot instance interruption. No new game servers are started on this instance.
Current status of the game server instance
" } }, "GameServerInstances": { "base": null, "refs": { - "DescribeGameServerInstancesOutput$GameServerInstances": "The collection of requested game server instances.
" + "DescribeGameServerInstancesOutput$GameServerInstances": "The collection of requested game server instances.
" } }, "GameServerProtectionPolicy": { @@ -1339,7 +1496,7 @@ } }, "GameSession": { - "base": "Properties describing a game session.
A game session in ACTIVE status can host players. When a game session ends, its status is set to TERMINATED.
Once the session ends, the game session object is retained for 30 days. This means you can reuse idempotency token values after this time. Game session logs are retained for 14 days.
Related actions
CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task
", + "base": "Properties describing a game session.
A game session in ACTIVE status can host players. When a game session ends, its status is set to TERMINATED.
Once the session ends, the game session object is retained for 30 days. This means you can reuse idempotency token values after this time. Game session logs are retained for 14 days.
", "refs": { "CreateGameSessionOutput$GameSession": "Object that describes the newly created game session record.
", "GameSessionDetail$GameSession": "Object that describes a game session.
", @@ -1354,17 +1511,17 @@ } }, "GameSessionConnectionInfo": { - "base": "Connection information for a new game session that is created in response to a StartMatchmaking request. Once a match is made, the FlexMatch engine creates a new game session for it. This information, including the game session endpoint and player sessions for each player in the original matchmaking request, is added to the MatchmakingTicket, which can be retrieved by calling DescribeMatchmaking.
", + "base": "Connection information for a new game session that is created in response to a start matchmaking request. Once a match is made, the FlexMatch engine creates a new game session for it. This information, including the game session endpoint and player sessions for each player in the original matchmaking request, is added to the matchmaking ticket.
", "refs": { - "MatchmakingTicket$GameSessionConnectionInfo": "Identifier and connection information of the game session created for the match. This information is added to the ticket only after the matchmaking request has been successfully completed. This parameter is not set when FlexMatch is being used without GameLift hosting.
" + "MatchmakingTicket$GameSessionConnectionInfo": "Connection information for a new game session. Once a match is made, the FlexMatch engine creates a new game session for it. This information is added to the matchmaking ticket, which you can be retrieve by calling DescribeMatchmaking .
" } }, "GameSessionData": { "base": null, "refs": { - "CreateMatchmakingConfigurationInput$GameSessionData": "A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match. This parameter is not used if FlexMatchMode is set to STANDALONE.
A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match. This parameter is not used when FlexMatchMode is set to STANDALONE.
A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match. This parameter is not used if FlexMatchMode is set to STANDALONE.
A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match. This parameter is not used if FlexMatchMode is set to STANDALONE.
A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match. This parameter is not used when FlexMatchMode is set to STANDALONE.
A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session (see Start a Game Session). This information is added to the game session that is created for a successful match. This parameter is not used if FlexMatchMode is set to STANDALONE.
Object that describes a StartGameSessionPlacement request. This object includes the full details of the original request plus the current status and start/end time stamps.
Game session placement-related operations include:
", + "base": "This object includes the full details of the original request plus the current status and start/end time stamps.
", "refs": { "DescribeGameSessionPlacementOutput$GameSessionPlacement": "Object that describes the requested game session placement.
", "StartGameSessionPlacementOutput$GameSessionPlacement": "Object that describes the newly created game session placement. This object includes all the information provided in the request, as well as start/end time stamps and placement status.
", @@ -1402,11 +1559,11 @@ "GameSessionPlacementState": { "base": null, "refs": { - "GameSessionPlacement$Status": "Current status of the game session placement request.
PENDING -- The placement request is currently in the queue waiting to be processed.
FULFILLED -- A new game session and player sessions (if requested) have been successfully created. Values for GameSessionArn and GameSessionRegion are available.
CANCELLED -- The placement request was canceled with a call to StopGameSessionPlacement.
TIMED_OUT -- A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed.
FAILED -- GameLift is not able to complete the process of placing the game session. Common reasons are the game session terminated before the placement process was completed, or an unexpected internal error.
Current status of the game session placement request.
PENDING -- The placement request is currently in the queue waiting to be processed.
FULFILLED -- A new game session and player sessions (if requested) have been successfully created. Values for GameSessionArn and GameSessionRegion are available.
CANCELLED -- The placement request was canceled.
TIMED_OUT -- A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed.
FAILED -- GameLift is not able to complete the process of placing the game session. Common reasons are the game session terminated before the placement process was completed, or an unexpected internal error.
Configuration for a game session placement mechanism that processes requests for new game sessions. A queue can be used on its own or as part of a matchmaking solution.
Related actions
CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue
", + "base": "Configuration for a game session placement mechanism that processes requests for new game sessions. A queue can be used on its own or as part of a matchmaking solution.
", "refs": { "CreateGameSessionQueueOutput$GameSessionQueue": "An object that describes the newly created game session queue.
", "GameSessionQueueList$member": null, @@ -1420,7 +1577,7 @@ } }, "GameSessionQueueDestination": { - "base": "A fleet or alias designated in a game session queue. Queues fulfill requests for new game sessions by placing a new game session on any of the queue's destinations.
Destinations are part of a GameSessionQueue.
", + "base": "A fleet or alias designated in a game session queue. Queues fulfill requests for new game sessions by placing a new game session on any of the queue's destinations.
", "refs": { "GameSessionQueueDestinationList$member": null } @@ -1474,23 +1631,43 @@ "GameSession$StatusReason": "Provides additional information about game session status. INTERRUPTED indicates that the game session was hosted on a spot instance that was reclaimed, causing the active game session to be terminated.
Represents the input for a request operation.
", + "base": null, "refs": { } }, "GetGameSessionLogUrlOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "GetInstanceAccessInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "GetInstanceAccessOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, @@ -1505,12 +1682,12 @@ "IdStringModel": { "base": null, "refs": { - "CreateGameSessionInput$GameSessionId": " This parameter is no longer preferred. Please use IdempotencyToken instead. Custom string that uniquely identifies a request for a new game session. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID.
This parameter is deprecated. Use IdempotencyToken instead.
Custom string that uniquely identifies a request for a new game session. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID.
", "CreateGameSessionInput$IdempotencyToken": "Custom string that uniquely identifies the new game session request. This is useful for ensuring that game session requests with the same idempotency token are processed only once. Subsequent requests with the same string return the original GameSession object, with an updated status. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID. A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>. Idempotency tokens remain in use for 30 days after a game session has ended; game session objects are retained for this time period and then deleted.
A unique identifier for a game session placement to retrieve.
", "GameSessionPlacement$PlacementId": "A unique identifier for a game session placement.
", - "StartGameSessionPlacementInput$PlacementId": "A unique identifier to assign to the new game session placement. This value is developer-defined. The value must be unique across all Regions and cannot be reused unless you are resubmitting a canceled or timed-out placement request.
", - "StopGameSessionPlacementInput$PlacementId": "A unique identifier for a game session placement to cancel.
" + "StartGameSessionPlacementInput$PlacementId": "A unique identifier to assign to the new game session placement. This value is developer-defined. The value must be unique across all Regions and cannot be reused.
", + "StopGameSessionPlacementInput$PlacementId": "A unique identifier for a game session placement to stop.
" } }, "IdempotentParameterMismatchException": { @@ -1519,25 +1696,25 @@ } }, "Instance": { - "base": "Represents an EC2 instance of virtual computing resources that hosts one or more game servers. In GameLift, a fleet can contain zero or more instances.
Related actions
", + "base": "Represents an EC2 instance of virtual computing resources that hosts one or more game servers. In GameLift, a fleet can contain zero or more instances.
Related actions
", "refs": { "InstanceList$member": null } }, "InstanceAccess": { - "base": "Information required to remotely connect to a fleet instance. Access is requested by calling GetInstanceAccess.
", + "base": "Information required to remotely connect to a fleet instance.
", "refs": { "GetInstanceAccessOutput$InstanceAccess": "The connection information for a fleet instance, including IP address and access credentials.
" } }, "InstanceCredentials": { - "base": "Set of credentials required to remotely access a fleet instance. Access credentials are requested by calling GetInstanceAccess and returned in an InstanceAccess object.
", + "base": "Set of credentials required to remotely access a fleet instance.
", "refs": { "InstanceAccess$Credentials": "Credentials required to access the instance.
" } }, "InstanceDefinition": { - "base": "This data type is used with the GameLift FleetIQ and game server groups.
An allowed instance type for a GameServerGroup. All game server groups must have at least two instance types defined for it. GameLift FleetIQ periodically evaluates each defined instance type for viability. It then updates the Auto Scaling group with the list of viable instance types.
", + "base": "This data type is used with the GameLift FleetIQ and game server groups.
An allowed instance type for a game server group. All game server groups must have at least two instance types defined for it. GameLift FleetIQ periodically evaluates each defined instance type for viability. It then updates the Auto Scaling group with the list of viable instance types.
", "refs": { "InstanceDefinitions$member": null } @@ -1601,15 +1778,18 @@ "IpAddress": { "base": null, "refs": { + "Compute$IpAddress": "The IP address of the compute resource. GameLift requires the DNS name or IP address to manage your compute resource.
", "GameSession$IpAddress": "The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number.
", + "GameSessionConnectionInfo$IpAddress": "The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number.
", "GameSessionPlacement$IpAddress": "The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED).
IP address that is assigned to the instance.
", "InstanceAccess$IpAddress": "IP address that is assigned to the instance.
", - "PlayerSession$IpAddress": "The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number.
" + "PlayerSession$IpAddress": "The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number.
", + "RegisterComputeInput$IpAddress": "The IP address of the compute resource. GameLift requires the DNS name or IP address to manage your compute resource.
" } }, "IpPermission": { - "base": "A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an instance in a fleet. New game sessions are assigned an IP address/port number combination, which must fall into the fleet's allowed ranges. Fleets with custom game builds must have permissions explicitly set. For Realtime Servers fleets, GameLift automatically opens two port ranges, one for TCP messaging and one for UDP.
Related actions
", + "base": "A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an instance in a fleet. New game sessions are assigned an IP address/port number combination, which must fall into the fleet's allowed ranges. Fleets with custom game builds must have permissions explicitly set. For Realtime Servers fleets, GameLift automatically opens two port ranges, one for TCP messaging and one for UDP.
", "refs": { "IpPermissionsList$member": null } @@ -1632,10 +1812,10 @@ "LargeGameSessionData": { "base": null, "refs": { - "CreateGameSessionInput$GameSessionData": "A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).
", - "GameSession$GameSessionData": "A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).
", - "GameSessionPlacement$GameSessionData": "A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).
", - "StartGameSessionPlacementInput$GameSessionData": "A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).
" + "CreateGameSessionInput$GameSessionData": "A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session (see Start a Game Session).
", + "GameSession$GameSessionData": "A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session (see Start a Game Session).
", + "GameSessionPlacement$GameSessionData": "A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).
A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).
This parameter is no longer used. Specify server launch parameters using the RuntimeConfiguration parameter. Requests that use this parameter instead continue to be valid.
This parameter is no longer used. Server launch parameters are now defined using the fleet's RuntimeConfiguration parameter. Requests that use this parameter instead continue to be valid.
", + "FleetAttributes$ServerLaunchParameters": "This parameter is no longer used. Server launch parameters are now defined using the fleet's runtime configuration . Requests that use this parameter instead continue to be valid.
", "ServerProcess$Parameters": "An optional list of parameters to pass to the server executable or Realtime script on launch.
" } }, @@ -1656,7 +1836,7 @@ "base": null, "refs": { "CreateFleetInput$ServerLaunchPath": " This parameter is no longer used. Specify a server launch path using the RuntimeConfiguration parameter. Requests that use this parameter instead continue to be valid.
This parameter is no longer used. Server launch paths are now defined using the fleet's RuntimeConfiguration parameter. Requests that use this parameter instead continue to be valid.
", + "FleetAttributes$ServerLaunchPath": "This parameter is no longer used. Server launch paths are now defined using the fleet's RuntimeConfiguration . Requests that use this parameter instead continue to be valid.
", "ServerProcess$LaunchPath": "The location of a game build executable or the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root:
Windows (custom game builds only): C:\\game. Example: \"C:\\game\\MyGame\\server.exe\"
Linux: /local/game. Examples: \"/local/game/MyGame/server.exe\" or \"/local/game/MyRealtimeScript.js\"
This data type is used with the GameLift FleetIQ and game server groups.
An Amazon Elastic Compute Cloud launch template that contains configuration settings and game server code to be deployed to all instances in a game server group. The launch template is specified when creating a new game server group with CreateGameServerGroup.
", + "base": "This data type is used with the GameLift FleetIQ and game server groups.
An Amazon Elastic Compute Cloud launch template that contains configuration settings and game server code to be deployed to all instances in a game server group. The launch template is specified when creating a new game server group.
", "refs": { "CreateGameServerGroupInput$LaunchTemplate": "The Amazon EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. You can specify the template using either the template name or ID. For help with creating a launch template, see Creating a Launch Template for an Auto Scaling Group in the Amazon Elastic Compute Cloud Auto Scaling User Guide. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the Amazon Web Services console or APIs.
If you specify network interfaces in your launch template, you must explicitly set the property AssociatePublicIpAddress to \"true\". If no network interface is specified in the launch template, GameLift FleetIQ uses your account's default VPC.
Represents the input for a request operation.
", + "base": null, "refs": { } }, "ListAliasesOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "ListBuildsInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "ListBuildsOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, + "refs": { + } + }, + "ListComputeInput": { + "base": null, + "refs": { + } + }, + "ListComputeOutput": { + "base": null, "refs": { } }, "ListFleetsInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "ListFleetsOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, @@ -1739,6 +1929,22 @@ "refs": { } }, + "ListLocationsInput": { + "base": null, + "refs": { + } + }, + "ListLocationsLimit": { + "base": null, + "refs": { + "ListLocationsInput$Limit": "The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
The Amazon Resource Name (ARN) that is assigned to a GameLift location resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::location/location-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
Represents a location in a multi-location fleet.
Related actions
DescribeFleetLocationAttributes
", + "base": "Details about a location in a multi-location fleet.
", "refs": { "LocationAttributesList$member": null } @@ -1768,11 +1980,11 @@ "LocationAttributesList": { "base": null, "refs": { - "DescribeFleetLocationAttributesOutput$LocationAttributes": "Location-specific information on the requested fleet's remote locations.
" + "DescribeFleetLocationAttributesOutput$LocationAttributes": "Location-specific information on the requested fleet's remote locations.
" } }, "LocationConfiguration": { - "base": "A remote location where a multi-location fleet can deploy EC2 instances for game hosting.
Related actions
", + "base": "A remote location where a multi-location fleet can deploy EC2 instances for game hosting.
", "refs": { "LocationConfigurationList$member": null } @@ -1784,6 +1996,18 @@ "CreateFleetLocationsInput$Locations": "A list of locations to deploy additional instances to and manage as part of the fleet. You can add any GameLift-supported Amazon Web Services Region as a remote location, in the form of an Amazon Web Services Region code such as us-west-2.
Filters the list for AWS or CUSTOM locations.
The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION. Locations are identified by Amazon Web Services Region codes such as us-west-2. Each location can only be listed once.
Properties of a location
", + "refs": { + "CreateLocationOutput$Location": "The details of the custom location you created.
", + "LocationModelList$member": null + } + }, + "LocationModelList": { + "base": null, + "refs": { + "ListLocationsOutput$Locations": "A collection of locations.
" + } + }, "LocationState": { - "base": "A fleet location and its life-cycle state. A location state object might be used to describe a fleet's remote location or home Region. Life-cycle state tracks the progress of launching the first instance in a new location and preparing it for game hosting, and then removing all instances and deleting the location from the fleet.
Related actions
CreateFleet | CreateFleetLocations | DeleteFleetLocations
", + "base": "A fleet location and its life-cycle state. A location state object might be used to describe a fleet's remote location or home Region. Life-cycle state tracks the progress of launching the first instance in a new location and preparing it for game hosting, and then removing all instances and deleting the location from the fleet.
NEW -- A new fleet location has been defined and desired instances is set to 1.
DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- GameLift is setting up the new fleet location, creating new instances with the game build or Realtime script and starting server processes.
ACTIVE -- Hosts can now accept game sessions.
ERROR -- An error occurred when downloading, validating, building, or activating the fleet location.
DELETING -- Hosts are responding to a delete fleet location request.
TERMINATED -- The fleet location no longer exists.
NOT_FOUND -- The fleet location was not found. This could be because the custom location was removed or not created.
A fleet location and its current life-cycle state.
", "LocationStateList$member": null @@ -1811,14 +2048,15 @@ "LocationStringModel": { "base": null, "refs": { + "Compute$Location": "The name of the custom location you added to the fleet that this compute resource resides in.
", "CreateGameSessionInput$Location": "A fleet's remote location to place the new game session in. If this parameter is not set, the new game session is placed in the fleet's home Region. Specify a remote location with an Amazon Web Services Region code such as us-west-2.
The name of a remote location to request instance limits for, in the form of an Amazon Web Services Region code such as us-west-2.
The fleet location to retrieve capacity information for. Specify a location in the form of an Amazon Web Services Region code, such as us-west-2.
The fleet location to retrieve utilization information for. Specify a location in the form of an Amazon Web Services Region code, such as us-west-2.
A remote location to check for status of port setting updates. Use the Amazon Web Services Region code format, such as us-west-2.
The requested fleet location, expressed as an Amazon Web Services Region code, such as us-west-2.
A fleet location to get game sessions for. You can specify a fleet's home Region or a remote location. Use the Amazon Web Services Region code format, such as us-west-2.
A fleet location to get game session details for. You can specify a fleet's home Region or a remote location. Use the Amazon Web Services Region code format, such as us-west-2.
A fleet location to get game session details for. You can specify a fleet's home Region or a remote location. Use the Amazon Web Services Region code format, such as us-west-2.
A fleet location to get game sessions for. You can specify a fleet's home Region or a remote location. Use the Amazon Web Services Region code format, such as us-west-2.
The name of a location to retrieve instance information for, in the form of an Amazon Web Services Region code such as us-west-2.
The fleet location. If you don't specify this value, the response contains the scaling policies of every location in the fleet.
", "EC2InstanceLimit$Location": "An Amazon Web Services Region code, such as us-west-2.
The fleet location for the fleet utilization information, expressed as an Amazon Web Services Region code, such as us-west-2.
The fleet location where the game session is running. This value might specify the fleet's home Region or a remote location. Location is expressed as an Amazon Web Services Region code such as us-west-2.
The fleet location of the instance, expressed as an Amazon Web Services Region code, such as us-west-2.
The name of the custom location that the compute resources are assigned to.
", "LocationConfiguration$Location": "An Amazon Web Services Region code, such as us-west-2.
The location's name.
", "LocationState$Location": "The fleet location, expressed as an Amazon Web Services Region code such as us-west-2.
The name of the custom location you added to the fleet you are registering this compute resource to.
", "ScalingPolicy$Location": "The fleet location.
", - "SearchGameSessionsInput$Location": "A fleet location to search for game sessions. You can specify a fleet's home Region or a remote location. Use the Amazon Web Services Region code format, such as us-west-2.
", + "SearchGameSessionsInput$Location": "
A fleet location to search for game sessions. You can specify a fleet's home Region or a remote location. Use the Amazon Web Services Region code format, such as us-west-2.
The fleet location to restart fleet actions for. Specify a location in the form of an Amazon Web Services Region code, such as us-west-2.
The fleet location to stop fleet actions for. Specify a location in the form of an Amazon Web Services Region code, such as us-west-2.
The name of a remote location to update fleet capacity settings for, in the form of an Amazon Web Services Region code such as us-west-2.
The current status of updates to the fleet's port settings in the requested fleet location. A status of PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location.
The status of fleet activity updates to the location. The status PENDING_UPDATE indicates that StopFleetActions or StartFleetActions has been requested but the update has not yet been completed for the location.
The status of fleet activity updates to the location. The status PENDING_UPDATE indicates that StopFleetActions or StartFleetActions has been requested but the update has not yet been completed for the location.
The current status of the fleet's scaling policies in a requested fleet location. The status PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location.
A unique identifier for the matchmaking configuration. You can use either the configuration name or ARN value.
", "MatchmakingConfigurationNameList$member": null, - "StartMatchBackfillInput$ConfigurationName": "Name of the matchmaker to use for this request. You can use either the configuration name or ARN value. The ARN of the matchmaker that was used with the original game session is listed in the GameSession object, MatchmakerData property.
Name of the matchmaker to use for this request. You can use either the configuration name or ARN value. The ARN of the matchmaker that was used with the original game session is listed in the GameSession object, MatchmakerData property.
Name of the matchmaking configuration to use for this request. Matchmaking configurations must exist in the same Region as this request. You can use either the configuration name or ARN value.
", "UpdateMatchmakingConfigurationInput$Name": "A unique identifier for the matchmaking configuration to update. You can use either the configuration name or ARN value.
" } @@ -1912,7 +2153,7 @@ "MatchmakingConfigurationStatus": { "base": null, "refs": { - "MatchmakingTicket$Status": "Current status of the matchmaking request.
QUEUED -- The matchmaking request has been received and is currently waiting to be processed.
SEARCHING -- The matchmaking request is currently being processed.
REQUIRES_ACCEPTANCE -- A match has been proposed and the players must accept the match (see AcceptMatch). This status is used only with requests that use a matchmaking configuration with a player acceptance requirement.
PLACING -- The FlexMatch engine has matched players and is in the process of placing a new game session for the match.
COMPLETED -- Players have been matched and a game session is ready to host the players. A ticket in this state contains the necessary connection information for players.
FAILED -- The matchmaking request was not completed.
CANCELLED -- The matchmaking request was canceled. This may be the result of a call to StopMatchmaking or a proposed match that one or more players failed to accept.
TIMED_OUT -- The matchmaking request was not successful within the duration specified in the matchmaking configuration.
Matchmaking requests that fail to successfully complete (statuses FAILED, CANCELLED, TIMED_OUT) can be resubmitted as new requests with new ticket IDs.
Current status of the matchmaking request.
QUEUED -- The matchmaking request has been received and is currently waiting to be processed.
SEARCHING -- The matchmaking request is currently being processed.
REQUIRES_ACCEPTANCE -- A match has been proposed and the players must accept the match. This status is used only with requests that use a matchmaking configuration with a player acceptance requirement.
PLACING -- The FlexMatch engine has matched players and is in the process of placing a new game session for the match.
COMPLETED -- Players have been matched and a game session is ready to host the players. A ticket in this state contains the necessary connection information for players.
FAILED -- The matchmaking request was not completed.
CANCELLED -- The matchmaking request was canceled. This may be the result of a StopMatchmaking operation or a proposed match that one or more players failed to accept.
TIMED_OUT -- The matchmaking request was not successful within the duration specified in the matchmaking configuration.
Matchmaking requests that fail to successfully complete (statuses FAILED, CANCELLED, TIMED_OUT) can be resubmitted as new requests with new ticket IDs.
A unique identifier for the matchmaking rule set
", "MatchmakingTicket$TicketId": "A unique identifier for a matchmaking ticket.
", - "MatchmakingTicket$ConfigurationName": "Name of the MatchmakingConfiguration that is used with this ticket. Matchmaking configurations determine how players are grouped into a match and how a new game session is created for the match.
", + "MatchmakingTicket$ConfigurationName": "Name of the matchmaking configuration that is used with this ticket. Matchmaking configurations determine how players are grouped into a match and how a new game session is created for the match.
", "StartMatchBackfillInput$TicketId": "A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track the match backfill ticket status and retrieve match results.
", "StartMatchmakingInput$TicketId": "A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track the matchmaking ticket status and retrieve match results.
", "StopMatchmakingInput$TicketId": "A unique identifier for a matchmaking ticket.
" @@ -1947,7 +2188,7 @@ } }, "MatchmakingRuleSet": { - "base": "Set of rule statements, used with FlexMatch, that determine how to build your player matches. Each rule set describes a type of group to be created and defines the parameters for acceptable player matches. Rule sets are used in MatchmakingConfiguration objects.
A rule set may define the following elements for a match. For detailed information and examples showing how to construct a rule set, see Build a FlexMatch rule set.
Teams -- Required. A rule set must define one or multiple teams for the match and set minimum and maximum team sizes. For example, a rule set might describe a 4x4 match that requires all eight slots to be filled.
Player attributes -- Optional. These attributes specify a set of player characteristics to evaluate when looking for a match. Matchmaking requests that use a rule set with player attributes must provide the corresponding attribute values. For example, an attribute might specify a player's skill or level.
Rules -- Optional. Rules define how to evaluate potential players for a match based on player attributes. A rule might specify minimum requirements for individual players, teams, or entire matches. For example, a rule might require each player to meet a certain skill level, each team to have at least one player in a certain role, or the match to have a minimum average skill level. or may describe an entire group--such as all teams must be evenly matched or have at least one player in a certain role.
Expansions -- Optional. Expansions allow you to relax the rules after a period of time when no acceptable matches are found. This feature lets you balance getting players into games in a reasonable amount of time instead of making them wait indefinitely for the best possible match. For example, you might use an expansion to increase the maximum skill variance between players after 30 seconds.
Set of rule statements, used with FlexMatch, that determine how to build your player matches. Each rule set describes a type of group to be created and defines the parameters for acceptable player matches.
A rule set may define the following elements for a match. For detailed information and examples showing how to construct a rule set, see Build a FlexMatch rule set.
Teams -- Required. A rule set must define one or multiple teams for the match and set minimum and maximum team sizes. For example, a rule set might describe a 4x4 match that requires all eight slots to be filled.
Player attributes -- Optional. These attributes specify a set of player characteristics to evaluate when looking for a match. Matchmaking requests that use a rule set with player attributes must provide the corresponding attribute values. For example, an attribute might specify a player's skill or level.
Rules -- Optional. Rules define how to evaluate potential players for a match based on player attributes. A rule might specify minimum requirements for individual players, teams, or entire matches. For example, a rule might require each player to meet a certain skill level, each team to have at least one player in a certain role, or the match to have a minimum average skill level. or may describe an entire group--such as all teams must be evenly matched or have at least one player in a certain role.
Expansions -- Optional. Expansions allow you to relax the rules after a period of time when no acceptable matches are found. This feature lets you balance getting players into games in a reasonable amount of time instead of making them wait indefinitely for the best possible match. For example, you might use an expansion to increase the maximum skill variance between players after 30 seconds.
The newly created matchmaking rule set.
", "MatchmakingRuleSetList$member": null @@ -1983,7 +2224,7 @@ } }, "MatchmakingTicket": { - "base": "Ticket generated to track the progress of a matchmaking request. Each ticket is uniquely identified by a ticket ID, supplied by the requester, when creating a matchmaking request with StartMatchmaking. Tickets can be retrieved by calling DescribeMatchmaking with the ticket ID.
", + "base": "Ticket generated to track the progress of a matchmaking request. Each ticket is uniquely identified by a ticket ID, supplied by the requester, when creating a matchmaking request.
", "refs": { "MatchmakingTicketList$member": null, "StartMatchBackfillOutput$MatchmakingTicket": "Ticket representing the backfill matchmaking request. This object includes the information in the request, ticket status, and match results as generated during the matchmaking process.
", @@ -2067,7 +2308,7 @@ "ListScriptsOutput$NextToken": "A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
", "NotFoundException$Message": null, "OutOfCapacityException$Message": null, - "S3Location$Bucket": "An Amazon S3 bucket identifier. This is the name of the S3 bucket.
GameLift currently does not support uploading from Amazon S3 buckets with names that contain a dot (.).
An Amazon S3 bucket identifier. Thename of the S3 bucket.
GameLift doesn't support uploading from Amazon S3 buckets with names that contain a dot (.).
The name of the zip file that contains the build files or script files.
", "S3Location$RoleArn": "The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access the S3 bucket.
", "S3Location$ObjectVersion": "The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from an S3 bucket that you own. Use this parameter to specify a specific version of the file. If not set, the latest version of the file is retrieved.
", @@ -2083,23 +2324,28 @@ "TargetTrackingConfiguration$TargetValue": "Desired value to use with a game server group target-based scaling policy.
" } }, + "NonNegativeLimitedLengthDouble": { + "base": null, + "refs": { + "AnywhereConfiguration$Cost": "The cost to run your fleet per hour. GameLift uses the provided cost of your fleet to balance usage in queues. For more information about queues, see Setting up queues.
" + } + }, "NonZeroAndMaxString": { "base": null, "refs": { - "AttributeValue$S": "For single string values. Maximum string length is 100 characters.
", "CreateAliasInput$Description": "A human-readable description of the alias.
", - "CreateBuildInput$Name": "A descriptive label that is associated with a build. Build names do not need to be unique. You can use UpdateBuild to change this value later.
", - "CreateBuildInput$Version": "Version information that is associated with a build or script. Version strings do not need to be unique. You can use UpdateBuild to change this value later.
", + "CreateBuildInput$Name": "A descriptive label associated with a build. Build names do not need to be unique. You can change this value later.
", + "CreateBuildInput$Version": "Version information associated with a build or script. Version strings do not need to be unique. You can change this value later.
", "CreateFleetInput$Name": "A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
", - "CreateFleetInput$Description": "A human-readable description of the fleet.
", + "CreateFleetInput$Description": "A description for the fleet.
", "CreateFleetInput$PeerVpcAwsAccountId": "Used when peering your GameLift fleet with a VPC, the unique identifier for the Amazon Web Services account that owns the VPC. You can find your account ID in the Amazon Web Services Management Console under account settings.
", - "CreateFleetInput$PeerVpcId": "A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the Amazon Web Services Management Console. Learn more about VPC peering in VPC Peering with GameLift Fleets.
", + "CreateFleetInput$PeerVpcId": "A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the Amazon Web Services Management Console. Learn more about VPC peering in VPC Peering with GameLift Fleets.
", "CreateGameSessionInput$Name": "A descriptive label that is associated with a game session. Session names do not need to be unique.
", "CreateGameSessionInput$CreatorId": "A unique identifier for a player or entity creating the game session. This parameter is required when requesting a new game session on a fleet with a resource creation limit policy. This type of policy limits the number of concurrent active game sessions that one player can create within a certain time span. GameLift uses the CreatorId to evaluate the new request against the policy.
", "CreateMatchmakingConfigurationInput$Description": "A human-readable description of the matchmaking configuration.
", "CreatePlayerSessionInput$PlayerId": "A unique identifier for a player. Player IDs are developer-defined.
", - "CreateScriptInput$Name": "A descriptive label that is associated with a script. Script names do not need to be unique. You can use UpdateScript to change this value later.
", - "CreateScriptInput$Version": "Version information that is associated with a build or script. Version strings do not need to be unique. You can use UpdateScript to change this value later.
", + "CreateScriptInput$Name": "A descriptive label that is associated with a script. Script names do not need to be unique. You can use UpdateScript to change this value later.
", + "CreateScriptInput$Version": "Version information associated with a build or script. Version strings do not need to be unique. You can use UpdateScript to change this value later.
", "CreateVpcPeeringAuthorizationInput$GameLiftAwsAccountId": "A unique identifier for the Amazon Web Services account that you use to manage your GameLift fleet. You can find your Account ID in the Amazon Web Services Management Console under account settings.
", "CreateVpcPeeringAuthorizationInput$PeerVpcId": "A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the Amazon Web Services Management Console. Learn more about VPC peering in VPC Peering with GameLift Fleets.
", "CreateVpcPeeringConnectionInput$PeerVpcAwsAccountId": "A unique identifier for the Amazon Web Services account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your Account ID in the Amazon Web Services Management Console under account settings.
", @@ -2107,7 +2353,7 @@ "DeleteScalingPolicyInput$Name": "A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.
", "DeleteVpcPeeringAuthorizationInput$GameLiftAwsAccountId": "A unique identifier for the Amazon Web Services account that you use to manage your GameLift fleet. You can find your Account ID in the Amazon Web Services Management Console under account settings.
", "DeleteVpcPeeringAuthorizationInput$PeerVpcId": "A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the Amazon Web Services Management Console. Learn more about VPC peering in VPC Peering with GameLift Fleets.
", - "DeleteVpcPeeringConnectionInput$VpcPeeringConnectionId": "A unique identifier for a VPC peering connection. This value is included in the VpcPeeringConnection object, which can be retrieved by calling DescribeVpcPeeringConnections.
", + "DeleteVpcPeeringConnectionInput$VpcPeeringConnectionId": "A unique identifier for a VPC peering connection.
", "DescribeFleetAttributesInput$NextToken": "A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet IDs.
", "DescribeFleetAttributesOutput$NextToken": "A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
", "DescribeFleetCapacityInput$NextToken": "A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet IDs.
", @@ -2118,8 +2364,8 @@ "DescribeFleetLocationAttributesOutput$NextToken": "A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
", "DescribeFleetUtilizationInput$NextToken": "A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet IDs.
", "DescribeFleetUtilizationOutput$NextToken": "A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
", - "DescribeGameServerInstancesInput$NextToken": "A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.
", - "DescribeGameServerInstancesOutput$NextToken": "A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
", + "DescribeGameServerInstancesInput$NextToken": "A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.
", + "DescribeGameServerInstancesOutput$NextToken": "A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
", "DescribeGameSessionDetailsInput$StatusFilter": "Game session status to filter results on. Possible game session statuses include ACTIVE, TERMINATED, ACTIVATING and TERMINATING (the last two are transitory).
A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.
", "DescribeGameSessionDetailsOutput$NextToken": "A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
", @@ -2135,7 +2381,7 @@ "DescribeMatchmakingRuleSetsInput$NextToken": "A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.
", "DescribeMatchmakingRuleSetsOutput$NextToken": "A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
", "DescribePlayerSessionsInput$PlayerId": "A unique identifier for a player to retrieve player sessions for.
", - "DescribePlayerSessionsInput$PlayerSessionStatusFilter": "Player session status to filter results on.
Possible player session statuses include the following:
RESERVED -- The player session request has been received, but the player has not yet connected to the server process and/or been validated.
ACTIVE -- The player has been validated by the server process and is currently connected.
COMPLETED -- The player connection has been dropped.
TIMEDOUT -- A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).
Player session status to filter results on. Note that when a PlayerSessionId or PlayerId is provided in a DescribePlayerSessions request, then the PlayerSessionStatusFilter has no effect on the response.
Possible player session statuses include the following:
RESERVED -- The player session request has been received, but the player has not yet connected to the server process and/or been validated.
ACTIVE -- The player has been validated by the server process and is currently connected.
COMPLETED -- The player connection has been dropped.
TIMEDOUT -- A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).
A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value. If a player session ID is specified, this parameter is ignored.
", "DescribePlayerSessionsOutput$NextToken": "A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
", "DescribeScalingPoliciesInput$NextToken": "A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.
", @@ -2155,12 +2401,16 @@ "GameSessionPlacement$GameSessionArn": "Identifier for the game session created by this placement request. This value is set once the new game session is placed (placement status is FULFILLED). This identifier is unique across all Regions. You can use this value as a GameSessionId value as needed.
Name of the Region where the game session created by this placement request is running. This value is set once the new game session is placed (placement status is FULFILLED).
Location of the requested game session logs, available for download. This URL is valid for 15 minutes, after which S3 will reject any download request using this URL. You can request a new URL any time within the 14-day period that the logs are retained.
", + "ListComputeInput$NextToken": "A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.
", + "ListComputeOutput$NextToken": "A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
", "ListFleetsInput$NextToken": "A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.
", "ListFleetsOutput$NextToken": "A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
", - "ListGameServerGroupsInput$NextToken": "A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.
", - "ListGameServerGroupsOutput$NextToken": "A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
", + "ListGameServerGroupsInput$NextToken": "Specify the pagination token from a previous request to retrieve the next page of results.
", + "ListGameServerGroupsOutput$NextToken": "Specify the pagination token from a previous request to retrieve the next page of results.
", "ListGameServersInput$NextToken": "A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.
", "ListGameServersOutput$NextToken": "A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
", + "ListLocationsInput$NextToken": "A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.
", + "ListLocationsOutput$NextToken": "A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
", "MatchedPlayerSession$PlayerId": "A unique identifier for a player
", "MatchmakingConfiguration$Description": "A descriptive label that is associated with matchmaking configuration.
", "PlacedPlayerSession$PlayerId": "A unique identifier for a player that is associated with this player session.
", @@ -2175,30 +2425,30 @@ "PlayerSession$GameSessionId": "A unique identifier for the game session that the player session is connected to.
", "PutScalingPolicyInput$Name": "A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name.
", "PutScalingPolicyOutput$Name": "A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.
", + "RegisterComputeInput$CertificatePath": "The path to the TLS certificate on your compute resource. The path and certificate are not validated by GameLift.
", "ScalingPolicy$Name": "A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.
", "Script$Name": "A descriptive label that is associated with a script. Script names do not need to be unique.
", - "Script$Version": "Version information that is associated with a build or script. Version strings do not need to be unique.
", + "Script$Version": "Version information associated with a build or script. Version strings do not need to be unique.
", "SearchGameSessionsInput$FilterExpression": "String containing the search criteria for the session search. If no filter expression is included, the request returns results for all game sessions in the fleet that are in ACTIVE status.
A filter expression can contain one or multiple conditions. Each condition consists of the following:
Operand -- Name of a game session attribute. Valid values are gameSessionName, gameSessionId, gameSessionProperties, maximumSessions, creationTimeMillis, playerSessionCount, hasAvailablePlayerSessions.
Comparator -- Valid comparators are: =, <>, <, >, <=, >=.
Value -- Value to be searched for. Values may be numbers, boolean values (true/false) or strings depending on the operand. String values are case sensitive and must be enclosed in single quotes. Special characters must be escaped. Boolean and string values can only be used with the comparators = and <>. For example, the following filter expression searches on gameSessionName: \"FilterExpression\": \"gameSessionName = 'Matt\\\\'s Awesome Game 1'\".
To chain multiple conditions in a single expression, use the logical keywords AND, OR, and NOT and parentheses as needed. For example: x AND y AND NOT z, NOT (x OR y).
Session search evaluates conditions from left to right using the following precedence rules:
=, <>, <, >, <=, >=
Parentheses
NOT
AND
OR
For example, this filter expression retrieves game sessions hosting at least ten players that have an open player slot: \"maximumSessions>=10 AND hasAvailablePlayerSessions=true\".
Instructions on how to sort the search results. If no sort expression is included, the request returns results in random order. A sort expression consists of the following elements:
Operand -- Name of a game session attribute. Valid values are gameSessionName, gameSessionId, gameSessionProperties, maximumSessions, creationTimeMillis, playerSessionCount, hasAvailablePlayerSessions.
Order -- Valid sort orders are ASC (ascending) and DESC (descending).
For example, this sort expression returns the oldest active sessions first: \"SortExpression\": \"creationTimeMillis ASC\". Results with a null value for the sort operand are returned at the end of the list.
A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.
", "SearchGameSessionsOutput$NextToken": "A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
", "StartGameSessionPlacementInput$GameSessionName": "A descriptive label that is associated with a game session. Session names do not need to be unique.
", - "StringDoubleMap$key": null, "StringList$member": null, "UpdateAliasInput$Description": "A human-readable description of the alias.
", - "UpdateBuildInput$Name": "A descriptive label that is associated with a build. Build names do not need to be unique.
", - "UpdateBuildInput$Version": "Version information that is associated with a build or script. Version strings do not need to be unique.
", + "UpdateBuildInput$Name": "A descriptive label associated with a build. Build names do not need to be unique.
", + "UpdateBuildInput$Version": "Version information associated with a build or script. Version strings do not need to be unique.
", "UpdateFleetAttributesInput$Name": "A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
", "UpdateFleetAttributesInput$Description": "A human-readable description of a fleet.
", "UpdateGameSessionInput$Name": "A descriptive label that is associated with a game session. Session names do not need to be unique.
", - "UpdateMatchmakingConfigurationInput$Description": "A descriptive label that is associated with matchmaking configuration.
", + "UpdateMatchmakingConfigurationInput$Description": "A description for the matchmaking configuration.
", "UpdateScriptInput$Name": "A descriptive label that is associated with a script. Script names do not need to be unique.
", - "UpdateScriptInput$Version": "Version information that is associated with a build or script. Version strings do not need to be unique.
", + "UpdateScriptInput$Version": "Version information associated with a build or script. Version strings do not need to be unique.
", "VpcPeeringAuthorization$GameLiftAwsAccountId": "A unique identifier for the Amazon Web Services account that you use to manage your GameLift fleet. You can find your Account ID in the Amazon Web Services Management Console under account settings.
", - "VpcPeeringAuthorization$PeerVpcAwsAccountId": "", + "VpcPeeringAuthorization$PeerVpcAwsAccountId": "The authorization's peer VPC Amazon Web Services account ID.
", "VpcPeeringAuthorization$PeerVpcId": "A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the Amazon Web Services Management Console. Learn more about VPC peering in VPC Peering with GameLift Fleets.
", "VpcPeeringConnection$IpV4CidrBlock": "CIDR block of IPv4 addresses assigned to the VPC peering connection for the GameLift VPC. The peered VPC also has an IPv4 CIDR block associated with it; these blocks cannot overlap or the peering connection cannot be created.
", - "VpcPeeringConnection$VpcPeeringConnectionId": "A unique identifier that is automatically assigned to the connection record. This ID is referenced in VPC peering connection events, and is used when deleting a connection with DeleteVpcPeeringConnection.
", + "VpcPeeringConnection$VpcPeeringConnectionId": "A unique identifier that is automatically assigned to the connection record. This ID is referenced in VPC peering connection events, and is used when deleting a connection.
", "VpcPeeringConnection$PeerVpcId": "A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the Amazon Web Services Management Console. Learn more about VPC peering in VPC Peering with GameLift Fleets.
", "VpcPeeringConnection$GameLiftVpcId": "A unique identifier for the VPC that contains the Amazon GameLift fleet for this connection. This VPC is managed by Amazon GameLift and does not appear in your Amazon Web Services account.
", "VpcPeeringConnectionStatus$Code": "Code indicating the status of a VPC peering connection.
", @@ -2206,7 +2456,7 @@ } }, "NotFoundException": { - "base": "A service resource associated with the request could not be found. Clients should not retry such requests.
", + "base": "THe requested resources was not found. The resource was either not created yet or deleted.
", "refs": { } }, @@ -2214,19 +2464,20 @@ "base": null, "refs": { "Build$OperatingSystem": "Operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build.
", - "CreateBuildInput$OperatingSystem": "The operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build. If your game build contains multiple executables, they all must run on the same operating system. If an operating system is not specified when creating a build, Amazon GameLift uses the default value (WINDOWS_2012). This value cannot be changed later.
", + "Compute$OperatingSystem": "The type of operating system on your compute resource.
", + "CreateBuildInput$OperatingSystem": "The operating system that you built the game server binaries to run on. This value determines the type of fleet resources that you can use for this build. If your game build contains multiple executables, they all must run on the same operating system. If an operating system is not specified when creating a build, GameLift uses the default value (WINDOWS_2012). This value cannot be changed later.
", "FleetAttributes$OperatingSystem": "The operating system of the fleet's computing resources. A fleet's operating system is determined by the OS of the build or script that is deployed on this fleet.
", "Instance$OperatingSystem": "Operating system that is running on this instance.
", "InstanceAccess$OperatingSystem": "Operating system that is running on the instance.
" } }, "OutOfCapacityException": { - "base": "The specified game server group has no available game servers to fulfill a ClaimGameServer request. Clients can retry such requests immediately or after a waiting period.
The specified game server group has no available game servers to fulfill a ClaimGameServer request. Clients can retry such requests immediately or after a waiting period.
Information about a player session that was created as part of a StartGameSessionPlacement request. This object contains only the player ID and player session ID. To retrieve full details on a player session, call DescribePlayerSessions with the player session ID.
Related actions
CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task
", + "base": "Information about a player session. This object contains only the player ID and player session ID. To retrieve full details on a player session, call DescribePlayerSessions with the player session ID.
", "refs": { "PlacedPlayerSessionList$member": null } @@ -2234,7 +2485,7 @@ "PlacedPlayerSessionList": { "base": null, "refs": { - "GameSessionPlacement$PlacedPlayerSessions": "A collection of information on player sessions created in response to the game session placement request. These player sessions are created only once a new game session is successfully placed (placement status is FULFILLED). This information includes the player ID (as provided in the placement request) and the corresponding player session ID. Retrieve full player sessions by calling DescribePlayerSessions with the player session ID.
A collection of information on player sessions created in response to the game session placement request. These player sessions are created only once a new game session is successfully placed (placement status is FULFILLED). This information includes the player ID (as provided in the placement request) and the corresponding player session ID.
A collection of key:value pairs containing player information for use in matchmaking. Player attribute keys must match the playerAttributes used in a matchmaking rule set. Example: \"PlayerAttributes\": {\"skill\": {\"N\": \"23\"}, \"gameMode\": {\"S\": \"deathmatch\"}}.
A collection of key:value pairs containing player information for use in matchmaking. Player attribute keys must match the playerAttributes used in a matchmaking rule set. Example: \"PlayerAttributes\": {\"skill\": {\"N\": \"23\"}, \"gameMode\": {\"S\": \"deathmatch\"}}.
You can provide up to 10 PlayerAttributes.
For single string values. Maximum string length is 100 characters.
", + "PlayerAttributeStringDoubleMap$key": null, + "PlayerAttributeStringList$member": null + } + }, + "PlayerAttributeStringDoubleMap": { + "base": null, + "refs": { + "AttributeValue$SDM": "For a map of up to 10 data type:value pairs. Maximum length for each string value is 100 characters.
" + } + }, + "PlayerAttributeStringList": { + "base": null, + "refs": { + "AttributeValue$SL": "For a list of up to 100 strings. Maximum length for each string is 100 characters. Duplicate values are not recognized; all occurrences of the repeated value after the first of a repeated value are ignored.
" } }, "PlayerData": { @@ -2271,7 +2542,7 @@ } }, "PlayerLatency": { - "base": "Regional latency information for a player, used when requesting a new game session with StartGameSessionPlacement. This value indicates the amount of time lag that exists when the player is connected to a fleet in the specified Region. The relative difference between a player's latency values for multiple Regions are used to determine which fleets are best suited to place a new game session for the player.
", + "base": "Regional latency information for a player, used when requesting a new game session. This value indicates the amount of time lag that exists when the player is connected to a fleet in the specified Region. The relative difference between a player's latency values for multiple Regions are used to determine which fleets are best suited to place a new game session for the player.
", "refs": { "PlayerLatencyList$member": null } @@ -2279,12 +2550,12 @@ "PlayerLatencyList": { "base": null, "refs": { - "GameSessionPlacement$PlayerLatencies": "A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to @aws; Regions.
", - "StartGameSessionPlacementInput$PlayerLatencies": "A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to @aws; Regions. This information is used to try to place the new game session where it can offer the best possible gameplay experience for the players.
" + "GameSessionPlacement$PlayerLatencies": "A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to Amazon Web Services Regions.
", + "StartGameSessionPlacementInput$PlayerLatencies": "A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to Amazon Web Services Regions. This information is used to try to place the new game session where it can offer the best possible gameplay experience for the players.
" } }, "PlayerLatencyPolicy": { - "base": "Sets a latency cap for individual players when placing a game session. With a latency policy in force, a game session cannot be placed in a fleet location where a player reports latency higher than the cap. Latency policies are used only with placement request that provide player latency information. Player latency policies can be stacked to gradually relax latency requirements over time.
Latency policies are part of a GameSessionQueue.
", + "base": "Sets a latency cap for individual players when placing a game session. With a latency policy in force, a game session cannot be placed in a fleet location where a player reports latency higher than the cap. Latency policies are used only with placement request that provide player latency information. Player latency policies can be stacked to gradually relax latency requirements over time.
", "refs": { "PlayerLatencyPolicyList$member": null } @@ -2301,12 +2572,12 @@ "base": null, "refs": { "MatchmakingTicket$Players": "A set of Player objects, each representing a player to find matches for. Players are identified by a unique player ID and may include latency data for use during matchmaking. If the ticket is in status COMPLETED, the Player objects include the team the players were assigned to in the resulting match.
Match information on all players that are currently assigned to the game session. This information is used by the matchmaker to find new players and add them to the existing game.
PlayerID, PlayerAttributes, Team -- This information is maintained in the GameSession object, MatchmakerData property, for all players who are currently assigned to the game session. The matchmaker data is in JSON syntax, formatted as a string. For more details, see Match Data.
The backfill request must specify the team membership for every player. Do not specify team if you are not using backfill.
LatencyInMs -- If the matchmaker uses player latency, include a latency value, in milliseconds, for the Region that the game session is currently in. Do not include latency values for any other Region.
Information on each player to be matched. This information must include a player ID, and may contain player attributes and latency data to be used in the matchmaking process. After a successful match, Player objects contain the name of the team the player is assigned to.
Match information on all players that are currently assigned to the game session. This information is used by the matchmaker to find new players and add them to the existing game.
You can include up to 199 Players in a StartMatchBackfill request.
PlayerID, PlayerAttributes, Team -- This information is maintained in the GameSession object, MatchmakerData property, for all players who are currently assigned to the game session. The matchmaker data is in JSON syntax, formatted as a string. For more details, see Match Data.
The backfill request must specify the team membership for every player. Do not specify team if you are not using backfill.
LatencyInMs -- If the matchmaker uses player latency, include a latency value, in milliseconds, for the Region that the game session is currently in. Do not include latency values for any other Region.
Information on each player to be matched. This information must include a player ID, and may contain player attributes and latency data to be used in the matchmaking process. After a successful match, Player objects contain the name of the team the player is assigned to.
You can include up to 10 Players in a StartMatchmaking request.
Represents a player session. Player sessions are created either for a specific game session, or as part of a game session placement or matchmaking request. A player session can represents a reserved player slot in a game session (when status is RESERVED) or actual player activity in a game session (when status is ACTIVE). A player session object, including player data, is automatically passed to a game session when the player connects to the game session and is validated. After the game session ends, player sessions information is retained for 30 days and then removed.
Related actions
CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions | StartGameSessionPlacement | DescribeGameSessionPlacement | All APIs by task
", + "base": "Represents a player session. Player sessions are created either for a specific game session, or as part of a game session placement or matchmaking request. A player session can represents a reserved player slot in a game session (when status is RESERVED) or actual player activity in a game session (when status is ACTIVE). A player session object, including player data, is automatically passed to a game session when the player connects to the game session and is validated. After the game session ends, player sessions information is retained for 30 days and then removed.
Related actions
", "refs": { "CreatePlayerSessionOutput$PlayerSession": "Object that describes the newly created player session record.
", "PlayerSessionList$member": null @@ -2365,9 +2636,9 @@ "DescribeFleetAttributesInput$Limit": "The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This limit is not currently enforced.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This limit is not currently enforced.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. You can request up to 50 results.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
The game server groups' limit.
", "ListGameServersInput$Limit": "The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
", @@ -2398,7 +2670,7 @@ } }, "PriorityConfiguration": { - "base": "Custom prioritization settings for use by a game session queue when placing new game sessions with available game servers. When defined, this configuration replaces the default FleetIQ prioritization process, which is as follows:
If player latency data is included in a game session request, destinations and locations are prioritized first based on lowest average latency (1), then on lowest hosting cost (2), then on destination list order (3), and finally on location (alphabetical) (4). This approach ensures that the queue's top priority is to place game sessions where average player latency is lowest, and--if latency is the same--where the hosting cost is less, etc.
If player latency data is not included, destinations and locations are prioritized first on destination list order (1), and then on location (alphabetical) (2). This approach ensures that the queue's top priority is to place game sessions on the first destination fleet listed. If that fleet has multiple locations, the game session is placed on the first location (when listed alphabetically).
Changing the priority order will affect how game sessions are placed.
Priority configurations are part of a GameSessionQueue.
", + "base": "Custom prioritization settings for use by a game session queue when placing new game sessions with available game servers. When defined, this configuration replaces the default FleetIQ prioritization process, which is as follows:
If player latency data is included in a game session request, destinations and locations are prioritized first based on lowest average latency (1), then on lowest hosting cost (2), then on destination list order (3), and finally on location (alphabetical) (4). This approach ensures that the queue's top priority is to place game sessions where average player latency is lowest, and--if latency is the same--where the hosting cost is less, etc.
If player latency data is not included, destinations and locations are prioritized first on destination list order (1), and then on location (alphabetical) (2). This approach ensures that the queue's top priority is to place game sessions on the first destination fleet listed. If that fleet has multiple locations, the game session is placed on the first location (when listed alphabetically).
Changing the priority order will affect how game sessions are placed.
", "refs": { "CreateGameSessionQueueInput$PriorityConfiguration": "Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process.
", "GameSessionQueue$PriorityConfiguration": "Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process.
", @@ -2420,20 +2692,20 @@ "ProtectionPolicy": { "base": null, "refs": { - "CreateFleetInput$NewGameSessionProtectionPolicy": "The status of termination protection for active game sessions on the fleet. By default, this property is set to NoProtection. You can also set game session protection for an individual game session by calling UpdateGameSession.
NoProtection - Game sessions can be terminated during active gameplay as a result of a scale-down event.
FullProtection - Game sessions in ACTIVE status cannot be terminated during a scale-down event.
The status of termination protection for active game sessions on the fleet. By default, this property is set to NoProtection. You can also set game session protection for an individual game session by calling UpdateGameSession.
NoProtection - Game sessions can be terminated during active gameplay as a result of a scale-down event.
FullProtection - Game sessions in ACTIVE status cannot be terminated during a scale-down event.
The type of game session protection to set on all new instances that are started in the fleet.
NoProtection -- The game session can be terminated during a scale-down event.
FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.
Current status of protection for the game session.
NoProtection -- The game session can be terminated during a scale-down event.
FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.
The game session protection policy to apply to all new instances created in this fleet. Instances that already exist are not affected. You can set protection for individual instances using UpdateGameSession.
NoProtection -- The game session can be terminated during a scale-down event.
FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.
The game session protection policy to apply to all new instances created in this fleet. Instances that already exist are not affected. You can set protection for individual instances using UpdateGameSession .
NoProtection -- The game session can be terminated during a scale-down event.
FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.
Game session protection policy to apply to this game session only.
NoProtection -- The game session can be terminated during a scale-down event.
FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.
Represents the input for a request operation.
", + "base": null, "refs": { } }, "PutScalingPolicyOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, @@ -2448,9 +2720,9 @@ "QueueCustomEventData": { "base": null, "refs": { - "CreateGameSessionQueueInput$CustomEventData": "Information to be added to all events that are related to this game session queue.
", - "GameSessionQueue$CustomEventData": "Information that is added to all events that are related to this game session queue.
", - "UpdateGameSessionQueueInput$CustomEventData": "Information to be added to all events that are related to this game session queue.
" + "CreateGameSessionQueueInput$CustomEventData": "Information to be added to all events that are related to this game session queue.
", + "GameSessionQueue$CustomEventData": "Information that is added to all events that are related to this game session queue.
", + "UpdateGameSessionQueueInput$CustomEventData": "Information to be added to all events that are related to this game session queue.
" } }, "QueueSnsArnStringModel": { @@ -2461,6 +2733,16 @@ "UpdateGameSessionQueueInput$NotificationTarget": "An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement.
" } }, + "RegisterComputeInput": { + "base": null, + "refs": { + } + }, + "RegisterComputeOutput": { + "base": null, + "refs": { + } + }, "RegisterGameServerInput": { "base": null, "refs": { @@ -2472,30 +2754,30 @@ } }, "RequestUploadCredentialsInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "RequestUploadCredentialsOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "ResolveAliasInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "ResolveAliasOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "ResourceCreationLimitPolicy": { - "base": "A policy that puts limits on the number of game sessions that a player can create within a specified span of time. With this policy, you can control players' ability to consume available resources.
The policy is evaluated when a player tries to create a new game session. On receiving a CreateGameSession request, GameLift checks that the player (identified by CreatorId) has created fewer than game session limit in the specified time period.
The resource creation limit policy is included in FleetAttributes.
", + "base": "A policy that puts limits on the number of game sessions that a player can create within a specified span of time. With this policy, you can control players' ability to consume available resources.
The policy is evaluated when a player tries to create a new game session. On receiving a CreateGameSession request, GameLift checks that the player (identified by CreatorId) has created fewer than game session limit in the specified time period.
A policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time.
", - "FleetAttributes$ResourceCreationLimitPolicy": "The fleet policy that limits the number of game sessions an individual player can create over a span of time.
", + "FleetAttributes$ResourceCreationLimitPolicy": null, "UpdateFleetAttributesInput$ResourceCreationLimitPolicy": "Policy settings that limit the number of game sessions an individual player can create over a span of time.
" } }, @@ -2510,7 +2792,7 @@ } }, "RoutingStrategy": { - "base": "The routing configuration for a fleet alias.
Related actions
CreateAlias | ListAliases | DescribeAlias | UpdateAlias | DeleteAlias | ResolveAlias | All APIs by task
", + "base": "The routing configuration for a fleet alias.
Related actions
", "refs": { "Alias$RoutingStrategy": "The routing configuration, including routing type and fleet target, for the alias.
", "CreateAliasInput$RoutingStrategy": "The routing configuration, including routing type and fleet target, for the alias.
", @@ -2520,8 +2802,8 @@ "RoutingStrategyType": { "base": null, "refs": { - "ListAliasesInput$RoutingStrategyType": "The routing type to filter results on. Use this parameter to retrieve only aliases with a certain routing type. To retrieve all aliases, leave this parameter empty.
Possible routing types include the following:
SIMPLE -- The alias resolves to one specific fleet. Use this type when routing to active fleets.
TERMINAL -- The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the RoutingStrategy message embedded.
The type of routing strategy for the alias.
Possible routing types include the following:
SIMPLE - The alias resolves to one specific fleet. Use this type when routing to active fleets.
TERMINAL - The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the RoutingStrategy message embedded.
The routing type to filter results on. Use this parameter to retrieve only aliases with a certain routing type. To retrieve all aliases, leave this parameter empty.
Possible routing types include the following:
SIMPLE -- The alias resolves to one specific fleet. Use this type when routing to active fleets.
TERMINAL -- The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the RoutingStrategy message embedded.
The type of routing strategy for the alias.
Possible routing types include the following:
SIMPLE - The alias resolves to one specific fleet. Use this type when routing to active fleets.
TERMINAL - The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the message embedded.
A collection of server process configurations that describe the set of processes to run on each instance in a fleet. Server processes run either an executable in a custom game build or a Realtime Servers script. GameLift launches the configured processes, manages their life cycle, and replaces them as needed. Each instance checks regularly for an updated runtime configuration.
A GameLift instance is limited to 50 processes running concurrently. To calculate the total number of processes in a runtime configuration, add the values of the ConcurrentExecutions parameter for each ServerProcess. Learn more about Running Multiple Processes on a Fleet.
Related actions
DescribeRuntimeConfiguration | UpdateRuntimeConfiguration
", + "base": "A collection of server process configurations that describe the set of processes to run on each instance in a fleet. Server processes run either an executable in a custom game build or a Realtime Servers script. GameLift launches the configured processes, manages their life cycle, and replaces them as needed. Each instance checks regularly for an updated runtime configuration.
A GameLift instance is limited to 50 processes running concurrently. To calculate the total number of processes in a runtime configuration, add the values of the ConcurrentExecutions parameter for each server process. Learn more about Running Multiple Processes on a Fleet.
Instructions for how to launch and maintain server processes on instances in the fleet. The runtime configuration defines one or more server process configurations, each identifying a build executable or Realtime script file and the number of processes of that type to run concurrently.
The RuntimeConfiguration parameter is required unless the fleet is being configured using the older parameters ServerLaunchPath and ServerLaunchParameters, which are still supported for backward compatibility.
Instructions that describe how server processes should be launched and maintained on each instance in the fleet.
", - "UpdateRuntimeConfigurationInput$RuntimeConfiguration": "Instructions for launching server processes on each instance in the fleet. Server processes run either a custom game build executable or a Realtime Servers script. The runtime configuration lists the types of server processes to run on an instance, how to launch them, and the number of processes to run concurrently.
", + "UpdateRuntimeConfigurationInput$RuntimeConfiguration": "Instructions for alaunching server processes on each instance in the fleet. Server processes run either a custom game build executable or a Realtime Servers script. The runtime configuration lists the types of server processes to run on an instance, how to launch them, and the number of processes to run concurrently.
", "UpdateRuntimeConfigurationOutput$RuntimeConfiguration": "The runtime configuration currently in use by all instances in the fleet. If the update was successful, all property changes are shown.
" } }, "S3Location": { - "base": "The location in Amazon S3 where build or script files are stored for access by Amazon GameLift. This location is specified in CreateBuild, CreateScript, and UpdateScript requests.
", + "base": "The location in Amazon S3 where build or script files are stored for access by Amazon GameLift.
", "refs": { "CreateBuildInput$StorageLocation": "Information indicating where your game build files are stored. Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own. The storage location must specify an Amazon S3 bucket name and key. The location must also specify a role ARN that you set up to allow Amazon GameLift to access your Amazon S3 bucket. The S3 bucket and your new build must be in the same Region.
If a StorageLocation is specified, the size of your file can be found in your Amazon S3 bucket. Amazon GameLift will report a SizeOnDisk of 0.
Amazon S3 location for your game build file, including bucket name and key.
", "CreateScriptInput$StorageLocation": "The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the \"key\"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version.
Amazon S3 path and key, identifying where the game build files are stored.
", - "Script$StorageLocation": null, + "Script$StorageLocation": "The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the \"key\"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version.
The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the \"key\"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version.
The type of adjustment to make to a fleet's instance count (see FleetCapacity):
ChangeInCapacity -- add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down.
ExactCapacity -- set the instance count to the scaling adjustment value.
PercentChangeInCapacity -- increase or reduce the current instance count by the scaling adjustment, read as a percentage. Positive values scale up while negative values scale down; for example, a value of \"-10\" scales the fleet down by 10%.
The type of adjustment to make to a fleet's instance count (see FleetCapacity):
ChangeInCapacity -- add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down.
ExactCapacity -- set the instance count to the scaling adjustment value.
PercentChangeInCapacity -- increase or reduce the current instance count by the scaling adjustment, read as a percentage. Positive values scale up while negative values scale down.
The type of adjustment to make to a fleet's instance count:
ChangeInCapacity -- add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down.
ExactCapacity -- set the instance count to the scaling adjustment value.
PercentChangeInCapacity -- increase or reduce the current instance count by the scaling adjustment, read as a percentage. Positive values scale up while negative values scale down; for example, a value of \"-10\" scales the fleet down by 10%.
The type of adjustment to make to a fleet's instance count.
ChangeInCapacity -- add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down.
ExactCapacity -- set the instance count to the scaling adjustment value.
PercentChangeInCapacity -- increase or reduce the current instance count by the scaling adjustment, read as a percentage. Positive values scale up while negative values scale down.
Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID.
Related actions
DescribeFleetCapacity | UpdateFleetCapacity | DescribeEC2InstanceLimits | PutScalingPolicy | DescribeScalingPolicies | DeleteScalingPolicy | StopFleetActions | StartFleetActions | All APIs by task
", + "base": "Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID.
", "refs": { "ScalingPolicyList$member": null } @@ -2581,11 +2863,11 @@ "base": null, "refs": { "DescribeScalingPoliciesInput$StatusFilter": "Scaling policy status to filter results on. A scaling policy is only in force when in an ACTIVE status.
ACTIVE -- The scaling policy is currently in force.
UPDATEREQUESTED -- A request to update the scaling policy has been received.
UPDATING -- A change is being made to the scaling policy.
DELETEREQUESTED -- A request to delete the scaling policy has been received.
DELETING -- The scaling policy is being deleted.
DELETED -- The scaling policy has been deleted.
ERROR -- An error occurred in creating the policy. It should be removed and recreated.
Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets (see StopFleetActions; if suspended for a fleet, the policy status does not change. View a fleet's stopped actions by calling DescribeFleetCapacity.
ACTIVE -- The scaling policy can be used for auto-scaling a fleet.
UPDATE_REQUESTED -- A request to update the scaling policy has been received.
UPDATING -- A change is being made to the scaling policy.
DELETE_REQUESTED -- A request to delete the scaling policy has been received.
DELETING -- The scaling policy is being deleted.
DELETED -- The scaling policy has been deleted.
ERROR -- An error occurred in creating the policy. It should be removed and recreated.
Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets. If the policy is suspended for a fleet, the policy status does not change.
ACTIVE -- The scaling policy can be used for auto-scaling a fleet.
UPDATE_REQUESTED -- A request to update the scaling policy has been received.
UPDATING -- A change is being made to the scaling policy.
DELETE_REQUESTED -- A request to delete the scaling policy has been received.
DELETING -- The scaling policy is being deleted.
DELETED -- The scaling policy has been deleted.
ERROR -- An error occurred in creating the policy. It should be removed and recreated.
Properties describing a Realtime script.
Related actions
CreateScript | ListScripts | DescribeScript | UpdateScript | DeleteScript | All APIs by task
", + "base": "Properties describing a Realtime script.
Related actions
", "refs": { "CreateScriptOutput$Script": "The newly created script record with a unique script ID and ARN. The new script's storage location reflects an Amazon S3 location: (1) If the script was uploaded from an S3 bucket under your account, the storage location reflects the information that was provided in the CreateScript request; (2) If the script file was uploaded from a local zip file, the storage location reflects an S3 location controls by the Amazon GameLift service.
", "DescribeScriptOutput$Script": "A set of properties describing the requested script.
", @@ -2624,17 +2906,17 @@ } }, "SearchGameSessionsInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "SearchGameSessionsOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "ServerProcess": { - "base": "A set of instructions for launching server processes on each instance in a fleet. Server processes run either an executable in a custom game build or a Realtime Servers script. Server process configurations are part of a fleet's RuntimeConfiguration.
", + "base": "A set of instructions for launching server processes on each instance in a fleet. Server processes run either an executable in a custom game build or a Realtime Servers script. Server process configurations are part of a fleet's runtime configuration.
", "refs": { "ServerProcessList$member": null } @@ -2645,6 +2927,13 @@ "RuntimeConfiguration$ServerProcesses": "A collection of server process configurations that identify what server processes to run on each instance in a fleet.
" } }, + "ServerSdkVersion": { + "base": "Data type used for server SDK version.", + "refs": { + "Build$ServerSdkVersion": "The GameLift Server SDK version used to develop your game server.
", + "CreateBuildInput$ServerSdkVersion": "A server SDK version you used when integrating your game server build with GameLift. For more information see Integrate games with custom game servers.
" + } + }, "SnsArnStringModel": { "base": null, "refs": { @@ -2660,94 +2949,86 @@ } }, "StartFleetActionsInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "StartFleetActionsOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "StartGameSessionPlacementInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "StartGameSessionPlacementOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "StartMatchBackfillInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "StartMatchBackfillOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "StartMatchmakingInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "StartMatchmakingOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "StopFleetActionsInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "StopFleetActionsOutput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "StopGameSessionPlacementInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "StopGameSessionPlacementOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "StopMatchmakingInput": { - "base": "Represents the input for a request operation.
", - "refs": { - } - }, - "StopMatchmakingOutput": { "base": null, "refs": { } }, - "StringDoubleMap": { + "StopMatchmakingOutput": { "base": null, "refs": { - "AttributeValue$SDM": "For a map of up to 10 data type:value pairs. Maximum length for each string value is 100 characters.
" } }, "StringList": { "base": null, "refs": { "AcceptMatchInput$PlayerIds": "A unique identifier for a player delivering the response. This parameter can include one or multiple player IDs.
", - "AttributeValue$SL": "For a list of up to 100 strings. Maximum length for each string is 100 characters. Duplicate values are not recognized; all occurrences of the repeated value after the first of a repeated value are ignored.
", - "CreateFleetInput$LogPaths": " This parameter is no longer used. To specify where GameLift should store log files once a server process shuts down, use the GameLift server API ProcessReady() and specify one or more directory paths in logParameters. See more information in the Server API Reference.
This parameter is no longer used. To specify where GameLift should store log files once a server process shuts down, use the GameLift server API ProcessReady() and specify one or more directory paths in logParameters. For more information, see Initialize the server process in the GameLift Developer Guide.
This parameter is no longer used. Game session log paths are now defined using the GameLift server API ProcessReady() logParameters. See more information in the Server API Reference.
The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number.
", "MatchmakingTicket$StatusReason": "Code to explain the current status. For example, a status reason may indicate when a ticket has returned to SEARCHING status after a proposed match fails to receive player acceptances.
Additional information about the current status.
" } @@ -2763,7 +3044,7 @@ } }, "Tag": { - "base": "A label that can be assigned to a GameLift resource.
Learn more
Tagging Amazon Web Services Resources in the Amazon Web Services General Reference
Amazon Web Services Tagging Strategies
Related actions
TagResource | UntagResource | ListTagsForResource | All APIs by task
", + "base": "A label that can be assigned to a GameLift resource.
Learn more
Tagging Amazon Web Services Resources in the Amazon Web Services General Reference
Amazon Web Services Tagging Strategies
Related actions
", "refs": { "TagList$member": null } @@ -2771,7 +3052,7 @@ "TagKey": { "base": null, "refs": { - "Tag$Key": "The key for a developer-defined key:value pair for tagging an Amazon Web Services resource.
", + "Tag$Key": "The key for a developer-defined key:value pair for tagging an Amazon Web Services resource.
", "TagKeyList$member": null } }, @@ -2784,15 +3065,16 @@ "TagList": { "base": null, "refs": { - "CreateAliasInput$Tags": "A list of labels to assign to the new alias resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the Amazon Web Services General Reference for actual tagging limits.
", - "CreateBuildInput$Tags": "A list of labels to assign to the new build resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the Amazon Web Services General Reference for actual tagging limits.
", - "CreateFleetInput$Tags": "A list of labels to assign to the new fleet resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference. Once the fleet is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the Amazon Web Services General Reference for actual tagging limits.
", - "CreateGameServerGroupInput$Tags": "A list of labels to assign to the new game server group resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources is useful for resource management, access management, and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags, respectively. The maximum tag limit may be lower than stated. See the Amazon Web Services General Reference for actual tagging limits.
", - "CreateGameSessionQueueInput$Tags": "A list of labels to assign to the new game session queue resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the Amazon Web Services General Reference for actual tagging limits.
", - "CreateMatchmakingConfigurationInput$Tags": "A list of labels to assign to the new matchmaking configuration resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the Amazon Web Services General Reference for actual tagging limits.
", - "CreateMatchmakingRuleSetInput$Tags": "A list of labels to assign to the new matchmaking rule set resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the Amazon Web Services General Reference for actual tagging limits.
", - "CreateScriptInput$Tags": "A list of labels to assign to the new script resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the Amazon Web Services General Reference for actual tagging limits.
", - "ListTagsForResourceResponse$Tags": "The collection of tags that have been assigned to the specified resource.
", + "CreateAliasInput$Tags": "A list of labels to assign to the new alias resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
", + "CreateBuildInput$Tags": "A list of labels to assign to the new build resource. Tags are developer defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the Amazon Web Services General Reference for actual tagging limits.
", + "CreateFleetInput$Tags": "A list of labels to assign to the new fleet resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
", + "CreateGameServerGroupInput$Tags": "A list of labels to assign to the new game server group resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources is useful for resource management, access management, and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
", + "CreateGameSessionQueueInput$Tags": "A list of labels to assign to the new game session queue resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
", + "CreateLocationInput$Tags": "A list of labels to assign to the new matchmaking configuration resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Rareference.
", + "CreateMatchmakingConfigurationInput$Tags": "A list of labels to assign to the new matchmaking configuration resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
", + "CreateMatchmakingRuleSetInput$Tags": "A list of labels to assign to the new matchmaking rule set resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
", + "CreateScriptInput$Tags": "A list of labels to assign to the new script resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the Amazon Web Services General Reference for actual tagging limits.
", + "ListTagsForResourceResponse$Tags": "The collection of tags that have been assigned to the specified resource.
", "TagResourceRequest$Tags": "A list of one or more tags to assign to the specified GameLift resource. Tags are developer-defined and structured as key-value pairs. The maximum tag limit may be lower than stated. See Tagging Amazon Web Services Resources for actual tagging limits.
" } }, @@ -2809,29 +3091,29 @@ "TagValue": { "base": null, "refs": { - "Tag$Value": "The value for a developer-defined key:value pair for tagging an Amazon Web Services resource.
" + "Tag$Value": "The value for a developer-defined key:value pair for tagging an Amazon Web Services resource.
" } }, "TaggingFailedException": { - "base": "The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
", + "base": "The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
", "refs": { } }, "TargetConfiguration": { - "base": "Settings for a target-based scaling policy (see ScalingPolicy. A target-based policy tracks a particular fleet metric specifies a target value for the metric. As player usage changes, the policy triggers Amazon GameLift to adjust capacity so that the metric returns to the target value. The target configuration specifies settings as needed for the target based policy, including the target value.
Related actions
DescribeFleetCapacity | UpdateFleetCapacity | DescribeEC2InstanceLimits | PutScalingPolicy | DescribeScalingPolicies | DeleteScalingPolicy | StopFleetActions | StartFleetActions | All APIs by task
", + "base": "Settings for a target-based scaling policy. A target-based policy tracks a particular fleet metric specifies a target value for the metric. As player usage changes, the policy triggers Amazon GameLift to adjust capacity so that the metric returns to the target value. The target configuration specifies settings as needed for the target based policy, including the target value.
", "refs": { "PutScalingPolicyInput$TargetConfiguration": "An object that contains settings for a target-based scaling policy.
", "ScalingPolicy$TargetConfiguration": "An object that contains settings for a target-based scaling policy.
" } }, "TargetTrackingConfiguration": { - "base": "This data type is used with the GameLift FleetIQ and game server groups.
Settings for a target-based scaling policy as part of a GameServerGroupAutoScalingPolicy. These settings are used to create a target-based policy that tracks the GameLift FleetIQ metric \"PercentUtilizedGameServers\" and specifies a target value for the metric. As player usage changes, the policy triggers to adjust the game server group capacity so that the metric returns to the target value.
This data type is used with the GameLift FleetIQ and game server groups.
Settings for a target-based scaling policy as part of a GameServerGroupAutoScalingPolicy . These settings are used to create a target-based policy that tracks the GameLift FleetIQ metric \"PercentUtilizedGameServers\" and specifies a target value for the metric. As player usage changes, the policy triggers to adjust the game server group capacity so that the metric returns to the target value.
Settings for a target-based scaling policy applied to Auto Scaling group. These settings are used to create a target-based policy that tracks the GameLift FleetIQ metric \"PercentUtilizedGameServers\" and specifies a target value for the metric. As player usage changes, the policy triggers to adjust the game server group capacity so that the metric returns to the target value.
The service is unable to resolve the routing for a particular alias because it has a terminal RoutingStrategy associated with it. The message returned in this exception is the message defined in the routing strategy itself. Such requests should only be retried if the routing strategy for the specified alias is modified.
", + "base": "The service is unable to resolve the routing for a particular alias because it has a terminal RoutingStrategy associated with it. The message returned in this exception is the message defined in the routing strategy itself. Such requests should only be retried if the routing strategy for the specified alias is modified.
A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
The time that this data object was last modified. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
The earliest date to retrieve event logs for. If no start time is specified, this call returns entries starting from when the fleet was created to the specified end time. Format is a number expressed in Unix time as milliseconds (ex: \"1469498468.057\").
", "DescribeFleetEventsInput$EndTime": "The most recent date to retrieve event logs for. If no end time is specified, this call returns entries from the specified start time up to the present. Format is a number expressed in Unix time as milliseconds (ex: \"1469498468.057\").
", "Event$EventTime": "Time stamp indicating when this event occurred. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
Timestamp that indicates when the game server was created with a RegisterGameServer request. The format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
Timestamp that indicates the last time the game server was claimed with a ClaimGameServer request. The format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\"). This value is used to calculate when a claimed game server's status should revert to null.
Timestamp that indicates the last time the game server was updated with health status using an UpdateGameServer request. The format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\"). After game server registration, this property is only changed when a game server update specifies a health check value.
Timestamp that indicates when the game server registered. The format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
Timestamp that indicates the last time the game server was claimed. The format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\"). This value is used to calculate when a claimed game server's status should revert to null.
Timestamp that indicates the last time the game server was updated with health status. The format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\"). After game server registration, this property is only changed when a game server update specifies a health check value.
A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
A timestamp that indicates when this game server group was last updated.
", "GameSession$CreationTime": "A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
Time stamp indicating when this request was placed in the queue. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
Time stamp indicating when this request was completed, canceled, or timed out.
", + "GetComputeAuthTokenOutput$ExpirationTimestamp": "The amount of time until the authorization token is no longer valid. To continue using the compute resource for game server hosting, renew the authorization token by using this operation again.
", "Instance$CreationTime": "A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
Time stamp indicating when this matchmaking request was received. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
Time stamp indicating when this matchmaking request stopped being processed due to success, failure, or cancellation. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
Time stamp indicating when the matchmaking request stopped being processed due to successful completion, timeout, or cancellation. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
Represents the input for a request operation.
", + "base": null, "refs": { } }, "UpdateAliasOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "UpdateBuildInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "UpdateBuildOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "UpdateFleetAttributesInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "UpdateFleetAttributesOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "UpdateFleetCapacityInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "UpdateFleetCapacityOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "UpdateFleetPortSettingsInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "UpdateFleetPortSettingsOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, @@ -2958,42 +3242,42 @@ } }, "UpdateGameSessionInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "UpdateGameSessionOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "UpdateGameSessionQueueInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "UpdateGameSessionQueueOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "UpdateMatchmakingConfigurationInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "UpdateMatchmakingConfigurationOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "UpdateRuntimeConfigurationInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "UpdateRuntimeConfigurationOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, @@ -3008,17 +3292,17 @@ } }, "ValidateMatchmakingRuleSetInput": { - "base": "Represents the input for a request operation.
", + "base": null, "refs": { } }, "ValidateMatchmakingRuleSetOutput": { - "base": "Represents the returned data in response to a request operation.
", + "base": null, "refs": { } }, "VpcPeeringAuthorization": { - "base": "Represents an authorization for a VPC peering connection between the VPC for an Amazon GameLift fleet and another VPC on an account you have access to. This authorization must exist and be valid for the peering connection to be established. Authorizations are valid for 24 hours after they are issued.
Related actions
CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections | DeleteVpcPeeringConnection | All APIs by task
", + "base": "Represents an authorization for a VPC peering connection between the VPC for an Amazon GameLift fleet and another VPC on an account you have access to. This authorization must exist and be valid for the peering connection to be established. Authorizations are valid for 24 hours after they are issued.
Related actions
", "refs": { "CreateVpcPeeringAuthorizationOutput$VpcPeeringAuthorization": "Details on the requested VPC peering authorization, including expiration.
", "VpcPeeringAuthorizationList$member": null @@ -3031,7 +3315,7 @@ } }, "VpcPeeringConnection": { - "base": "Represents a peering connection between a VPC on one of your Amazon Web Services accounts and the VPC for your Amazon GameLift fleets. This record may be for an active peering connection or a pending connection that has not yet been established.
Related actions
CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections | DeleteVpcPeeringConnection | All APIs by task
", + "base": "Represents a peering connection between a VPC on one of your Amazon Web Services accounts and the VPC for your Amazon GameLift fleets. This record may be for an active peering connection or a pending connection that has not yet been established.
Related actions
", "refs": { "VpcPeeringConnectionList$member": null } @@ -3043,7 +3327,7 @@ } }, "VpcPeeringConnectionStatus": { - "base": "Represents status information for a VPC peering connection. Status is associated with a VpcPeeringConnection object. Status codes and messages are provided from EC2 (see VpcPeeringConnectionStateReason). Connection status information is also communicated as a fleet Event.
", + "base": "Represents status information for a VPC peering connection. Status codes and messages are provided from EC2 (see VpcPeeringConnectionStateReason). Connection status information is also communicated as a fleet event.
", "refs": { "VpcPeeringConnection$Status": "The status information about the connection. Status indicates if a connection is pending, successful, or failed.
" } @@ -3094,7 +3378,7 @@ "MatchmakingTicket$EstimatedWaitTime": "Average amount of time (in seconds) that players are currently waiting for a match. If there is not enough recent data, this property may be empty.
", "PlayerLatencyPolicy$MaximumIndividualPlayerLatencyMilliseconds": "The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.
", "PlayerLatencyPolicy$PolicyDurationSeconds": "The length of time, in seconds, that the policy is enforced while placing a new game session. A null value for this property means that the policy is enforced until the queue times out.
", - "ResourceCreationLimitPolicy$NewGameSessionsPerCreator": "The maximum number of game sessions that an individual can create during the policy period.
", + "ResourceCreationLimitPolicy$NewGameSessionsPerCreator": "A policy that puts limits on the number of game sessions that a player can create within a specified span of time. With this policy, you can control players' ability to consume available resources.
The policy is evaluated when a player tries to create a new game session. On receiving a CreateGameSession request, GameLift checks that the player (identified by CreatorId) has created fewer than game session limit in the specified time period.
The time span used in evaluating the resource creation limit policy.
", "StartGameSessionPlacementInput$MaximumPlayerSessionCount": "The maximum number of players that can be connected simultaneously to the game session.
", "UpdateFleetCapacityInput$DesiredInstances": "The number of Amazon EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits.
", diff --git a/models/apis/gamelift/2015-10-01/endpoint-rule-set-1.json b/models/apis/gamelift/2015-10-01/endpoint-rule-set-1.json new file mode 100644 index 00000000000..e2f1b4442c4 --- /dev/null +++ b/models/apis/gamelift/2015-10-01/endpoint-rule-set-1.json @@ -0,0 +1,315 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": true, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://gamelift-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://gamelift-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://gamelift.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://gamelift.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] +} \ No newline at end of file diff --git a/models/apis/gamelift/2015-10-01/endpoint-tests-1.json b/models/apis/gamelift/2015-10-01/endpoint-tests-1.json new file mode 100644 index 00000000000..9bf00e4563d --- /dev/null +++ b/models/apis/gamelift/2015-10-01/endpoint-tests-1.json @@ -0,0 +1,1239 @@ +{ + "testCases": [ + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.ap-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-south-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-south-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.ap-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-south-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-south-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.eu-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-south-1", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.eu-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-south-1", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.eu-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-south-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.eu-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-south-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.ca-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ca-central-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ca-central-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.ca-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ca-central-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ca-central-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.eu-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-central-1", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-central-1", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.eu-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-central-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-central-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.us-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-west-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-west-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.us-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-west-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.us-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-west-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.us-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-west-2", + "UseFIPS": true + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-west-2", + "UseFIPS": true + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.us-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-west-2", + "UseFIPS": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.us-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-west-2", + "UseFIPS": false + } + }, + { + "documentation": "For region af-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.af-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "af-south-1", + "UseFIPS": true + } + }, + { + "documentation": "For region af-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.af-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "af-south-1", + "UseFIPS": true + } + }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.af-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "af-south-1", + "UseFIPS": false + } + }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.af-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "af-south-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.eu-north-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-north-1", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.eu-north-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-north-1", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.eu-north-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-north-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.eu-north-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-north-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.eu-west-3.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-west-3", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-west-3", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.eu-west-3.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-west-3", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-west-3", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.eu-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-west-2", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-west-2", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.eu-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-west-2", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-west-2", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.eu-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-west-1", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-west-1", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.eu-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-west-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-west-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.ap-northeast-3.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-northeast-3", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-northeast-3", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.ap-northeast-3.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-northeast-3", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-northeast-3", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.ap-northeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-northeast-2", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-northeast-2", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.ap-northeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-northeast-2", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-northeast-2", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.ap-northeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-northeast-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-northeast-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.ap-northeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-northeast-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-northeast-1", + "UseFIPS": false + } + }, + { + "documentation": "For region me-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.me-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "me-south-1", + "UseFIPS": true + } + }, + { + "documentation": "For region me-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.me-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "me-south-1", + "UseFIPS": true + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.me-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "me-south-1", + "UseFIPS": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.me-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "me-south-1", + "UseFIPS": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.sa-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "sa-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "sa-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.sa-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "sa-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "sa-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.ap-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.ap-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.ap-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.ap-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseDualStack": true, + "Region": "cn-north-1", + "UseFIPS": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseDualStack": false, + "Region": "cn-north-1", + "UseFIPS": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseDualStack": true, + "Region": "cn-north-1", + "UseFIPS": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseDualStack": false, + "Region": "cn-north-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.ap-southeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-southeast-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-southeast-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.ap-southeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-southeast-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-southeast-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.ap-southeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-southeast-2", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-southeast-2", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.ap-southeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-southeast-2", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-southeast-2", + "UseFIPS": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.us-east-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-east-2", + "UseFIPS": true + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-east-2", + "UseFIPS": true + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.us-east-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-east-2", + "UseFIPS": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.us-east-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-east-2", + "UseFIPS": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseDualStack": true, + "Region": "cn-northwest-1", + "UseFIPS": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift-fips.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "UseDualStack": false, + "Region": "cn-northwest-1", + "UseFIPS": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://gamelift.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseDualStack": true, + "Region": "cn-northwest-1", + "UseFIPS": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://gamelift.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "UseDualStack": false, + "Region": "cn-northwest-1", + "UseFIPS": false + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-east-1", + "UseFIPS": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "UseDualStack": false, + "Region": "us-east-1", + "UseFIPS": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "UseDualStack": true, + "Region": "us-east-1", + "UseFIPS": false, + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" +} \ No newline at end of file diff --git a/models/apis/gamelift/2015-10-01/paginators-1.json b/models/apis/gamelift/2015-10-01/paginators-1.json index 3102b1be368..9765c0a9e16 100644 --- a/models/apis/gamelift/2015-10-01/paginators-1.json +++ b/models/apis/gamelift/2015-10-01/paginators-1.json @@ -95,6 +95,12 @@ "limit_key": "Limit", "result_key": "Builds" }, + "ListCompute": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "Limit", + "result_key": "ComputeList" + }, "ListFleets": { "input_token": "NextToken", "output_token": "NextToken", @@ -113,6 +119,12 @@ "limit_key": "Limit", "result_key": "GameServers" }, + "ListLocations": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "Limit", + "result_key": "Locations" + }, "ListScripts": { "input_token": "NextToken", "output_token": "NextToken", diff --git a/models/apis/pipes/2015-10-07/api-2.json b/models/apis/pipes/2015-10-07/api-2.json new file mode 100644 index 00000000000..d198a43d783 --- /dev/null +++ b/models/apis/pipes/2015-10-07/api-2.json @@ -0,0 +1,1797 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2015-10-07", + "endpointPrefix":"pipes", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceFullName":"Amazon EventBridge Pipes", + "serviceId":"Pipes", + "signatureVersion":"v4", + "signingName":"pipes", + "uid":"pipes-2015-10-07" + }, + "operations":{ + "CreatePipe":{ + "name":"CreatePipe", + "http":{ + "method":"POST", + "requestUri":"/v1/pipes/{Name}", + "responseCode":200 + }, + "input":{"shape":"CreatePipeRequest"}, + "output":{"shape":"CreatePipeResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"NotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "idempotent":true + }, + "DeletePipe":{ + "name":"DeletePipe", + "http":{ + "method":"DELETE", + "requestUri":"/v1/pipes/{Name}", + "responseCode":200 + }, + "input":{"shape":"DeletePipeRequest"}, + "output":{"shape":"DeletePipeResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"NotFoundException"}, + {"shape":"ConflictException"} + ], + "idempotent":true + }, + "DescribePipe":{ + "name":"DescribePipe", + "http":{ + "method":"GET", + "requestUri":"/v1/pipes/{Name}", + "responseCode":200 + }, + "input":{"shape":"DescribePipeRequest"}, + "output":{"shape":"DescribePipeResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"NotFoundException"} + ] + }, + "ListPipes":{ + "name":"ListPipes", + "http":{ + "method":"GET", + "requestUri":"/v1/pipes", + "responseCode":200 + }, + "input":{"shape":"ListPipesRequest"}, + "output":{"shape":"ListPipesResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ] + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"ValidationException"}, + {"shape":"NotFoundException"} + ] + }, + "StartPipe":{ + "name":"StartPipe", + "http":{ + "method":"POST", + "requestUri":"/v1/pipes/{Name}/start", + "responseCode":200 + }, + "input":{"shape":"StartPipeRequest"}, + "output":{"shape":"StartPipeResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"NotFoundException"}, + {"shape":"ConflictException"} + ] + }, + "StopPipe":{ + "name":"StopPipe", + "http":{ + "method":"POST", + "requestUri":"/v1/pipes/{Name}/stop", + "responseCode":200 + }, + "input":{"shape":"StopPipeRequest"}, + "output":{"shape":"StopPipeResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"NotFoundException"}, + {"shape":"ConflictException"} + ] + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"ValidationException"}, + {"shape":"NotFoundException"} + ], + "idempotent":true + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"ValidationException"}, + {"shape":"NotFoundException"} + ], + "idempotent":true + }, + "UpdatePipe":{ + "name":"UpdatePipe", + "http":{ + "method":"PUT", + "requestUri":"/v1/pipes/{Name}", + "responseCode":200 + }, + "input":{"shape":"UpdatePipeRequest"}, + "output":{"shape":"UpdatePipeResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"NotFoundException"}, + {"shape":"ConflictException"} + ], + "idempotent":true + } + }, + "shapes":{ + "Arn":{ + "type":"string", + "max":1600, + "min":1, + "pattern":"^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.*)$" + }, + "ArnOrJsonPath":{ + "type":"string", + "max":1600, + "min":1, + "pattern":"^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.*)|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)$" + }, + "ArnOrUrl":{ + "type":"string", + "max":1600, + "min":1, + "pattern":"^smk://(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]):[0-9]{1,5}|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.*)$" + }, + "AssignPublicIp":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "AwsVpcConfiguration":{ + "type":"structure", + "required":["Subnets"], + "members":{ + "AssignPublicIp":{"shape":"AssignPublicIp"}, + "SecurityGroups":{"shape":"SecurityGroups"}, + "Subnets":{"shape":"Subnets"} + } + }, + "BatchArrayProperties":{ + "type":"structure", + "members":{ + "Size":{"shape":"BatchArraySize"} + } + }, + "BatchArraySize":{ + "type":"integer", + "max":10000, + "min":2 + }, + "BatchContainerOverrides":{ + "type":"structure", + "members":{ + "Command":{"shape":"StringList"}, + "Environment":{"shape":"BatchEnvironmentVariableList"}, + "InstanceType":{"shape":"String"}, + "ResourceRequirements":{"shape":"BatchResourceRequirementsList"} + } + }, + "BatchDependsOn":{ + "type":"list", + "member":{"shape":"BatchJobDependency"}, + "max":20, + "min":0 + }, + "BatchEnvironmentVariable":{ + "type":"structure", + "members":{ + "Name":{"shape":"String"}, + "Value":{"shape":"String"} + } + }, + "BatchEnvironmentVariableList":{ + "type":"list", + "member":{"shape":"BatchEnvironmentVariable"} + }, + "BatchJobDependency":{ + "type":"structure", + "members":{ + "JobId":{"shape":"String"}, + "Type":{"shape":"BatchJobDependencyType"} + } + }, + "BatchJobDependencyType":{ + "type":"string", + "enum":[ + "N_TO_N", + "SEQUENTIAL" + ] + }, + "BatchParametersMap":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "BatchResourceRequirement":{ + "type":"structure", + "required":[ + "Type", + "Value" + ], + "members":{ + "Type":{"shape":"BatchResourceRequirementType"}, + "Value":{"shape":"String"} + } + }, + "BatchResourceRequirementType":{ + "type":"string", + "enum":[ + "GPU", + "MEMORY", + "VCPU" + ] + }, + "BatchResourceRequirementsList":{ + "type":"list", + "member":{"shape":"BatchResourceRequirement"} + }, + "BatchRetryAttempts":{ + "type":"integer", + "max":10, + "min":1 + }, + "BatchRetryStrategy":{ + "type":"structure", + "members":{ + "Attempts":{"shape":"BatchRetryAttempts"} + } + }, + "Boolean":{"type":"boolean"}, + "CapacityProvider":{ + "type":"string", + "max":255, + "min":1, + "sensitive":true + }, + "CapacityProviderStrategy":{ + "type":"list", + "member":{"shape":"CapacityProviderStrategyItem"}, + "max":6, + "min":0 + }, + "CapacityProviderStrategyItem":{ + "type":"structure", + "required":["capacityProvider"], + "members":{ + "base":{"shape":"CapacityProviderStrategyItemBase"}, + "capacityProvider":{"shape":"CapacityProvider"}, + "weight":{"shape":"CapacityProviderStrategyItemWeight"} + } + }, + "CapacityProviderStrategyItemBase":{ + "type":"integer", + "max":100000, + "min":0 + }, + "CapacityProviderStrategyItemWeight":{ + "type":"integer", + "max":1000, + "min":0 + }, + "ConflictException":{ + "type":"structure", + "required":[ + "message", + "resourceId", + "resourceType" + ], + "members":{ + "message":{"shape":"String"}, + "resourceId":{"shape":"String"}, + "resourceType":{"shape":"String"} + }, + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "CreatePipeRequest":{ + "type":"structure", + "required":[ + "Name", + "RoleArn", + "Source", + "Target" + ], + "members":{ + "Description":{"shape":"PipeDescription"}, + "DesiredState":{"shape":"RequestedPipeState"}, + "Enrichment":{"shape":"OptionalArn"}, + "EnrichmentParameters":{"shape":"PipeEnrichmentParameters"}, + "Name":{ + "shape":"PipeName", + "location":"uri", + "locationName":"Name" + }, + "RoleArn":{"shape":"RoleArn"}, + "Source":{"shape":"ArnOrUrl"}, + "SourceParameters":{"shape":"PipeSourceParameters"}, + "Tags":{"shape":"TagMap"}, + "Target":{"shape":"Arn"}, + "TargetParameters":{"shape":"PipeTargetParameters"} + } + }, + "CreatePipeResponse":{ + "type":"structure", + "members":{ + "Arn":{"shape":"PipeArn"}, + "CreationTime":{"shape":"Timestamp"}, + "CurrentState":{"shape":"PipeState"}, + "DesiredState":{"shape":"RequestedPipeState"}, + "LastModifiedTime":{"shape":"Timestamp"}, + "Name":{"shape":"PipeName"} + } + }, + "Database":{ + "type":"string", + "max":64, + "min":1, + "sensitive":true + }, + "DbUser":{ + "type":"string", + "max":128, + "min":1, + "sensitive":true + }, + "DeadLetterConfig":{ + "type":"structure", + "members":{ + "Arn":{"shape":"Arn"} + } + }, + "DeletePipeRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"PipeName", + "location":"uri", + "locationName":"Name" + } + } + }, + "DeletePipeResponse":{ + "type":"structure", + "members":{ + "Arn":{"shape":"PipeArn"}, + "CreationTime":{"shape":"Timestamp"}, + "CurrentState":{"shape":"PipeState"}, + "DesiredState":{"shape":"RequestedPipeStateDescribeResponse"}, + "LastModifiedTime":{"shape":"Timestamp"}, + "Name":{"shape":"PipeName"} + } + }, + "DescribePipeRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"PipeName", + "location":"uri", + "locationName":"Name" + } + } + }, + "DescribePipeResponse":{ + "type":"structure", + "members":{ + "Arn":{"shape":"PipeArn"}, + "CreationTime":{"shape":"Timestamp"}, + "CurrentState":{"shape":"PipeState"}, + "Description":{"shape":"PipeDescription"}, + "DesiredState":{"shape":"RequestedPipeStateDescribeResponse"}, + "Enrichment":{"shape":"OptionalArn"}, + "EnrichmentParameters":{"shape":"PipeEnrichmentParameters"}, + "LastModifiedTime":{"shape":"Timestamp"}, + "Name":{"shape":"PipeName"}, + "RoleArn":{"shape":"RoleArn"}, + "Source":{"shape":"ArnOrUrl"}, + "SourceParameters":{"shape":"PipeSourceParameters"}, + "StateReason":{"shape":"PipeStateReason"}, + "Tags":{"shape":"TagMap"}, + "Target":{"shape":"Arn"}, + "TargetParameters":{"shape":"PipeTargetParameters"} + } + }, + "DynamoDBStreamStartPosition":{ + "type":"string", + "enum":[ + "TRIM_HORIZON", + "LATEST" + ] + }, + "EcsContainerOverride":{ + "type":"structure", + "members":{ + "Command":{"shape":"StringList"}, + "Cpu":{"shape":"Integer"}, + "Environment":{"shape":"EcsEnvironmentVariableList"}, + "EnvironmentFiles":{"shape":"EcsEnvironmentFileList"}, + "Memory":{"shape":"Integer"}, + "MemoryReservation":{"shape":"Integer"}, + "Name":{"shape":"String"}, + "ResourceRequirements":{"shape":"EcsResourceRequirementsList"} + } + }, + "EcsContainerOverrideList":{ + "type":"list", + "member":{"shape":"EcsContainerOverride"} + }, + "EcsEnvironmentFile":{ + "type":"structure", + "required":[ + "type", + "value" + ], + "members":{ + "type":{"shape":"EcsEnvironmentFileType"}, + "value":{"shape":"String"} + } + }, + "EcsEnvironmentFileList":{ + "type":"list", + "member":{"shape":"EcsEnvironmentFile"} + }, + "EcsEnvironmentFileType":{ + "type":"string", + "enum":["s3"] + }, + "EcsEnvironmentVariable":{ + "type":"structure", + "members":{ + "name":{"shape":"String"}, + "value":{"shape":"String"} + } + }, + "EcsEnvironmentVariableList":{ + "type":"list", + "member":{"shape":"EcsEnvironmentVariable"} + }, + "EcsEphemeralStorage":{ + "type":"structure", + "required":["sizeInGiB"], + "members":{ + "sizeInGiB":{"shape":"EphemeralStorageSize"} + } + }, + "EcsInferenceAcceleratorOverride":{ + "type":"structure", + "members":{ + "deviceName":{"shape":"String"}, + "deviceType":{"shape":"String"} + } + }, + "EcsInferenceAcceleratorOverrideList":{ + "type":"list", + "member":{"shape":"EcsInferenceAcceleratorOverride"} + }, + "EcsResourceRequirement":{ + "type":"structure", + "required":[ + "type", + "value" + ], + "members":{ + "type":{"shape":"EcsResourceRequirementType"}, + "value":{"shape":"String"} + } + }, + "EcsResourceRequirementType":{ + "type":"string", + "enum":[ + "GPU", + "InferenceAccelerator" + ] + }, + "EcsResourceRequirementsList":{ + "type":"list", + "member":{"shape":"EcsResourceRequirement"} + }, + "EcsTaskOverride":{ + "type":"structure", + "members":{ + "ContainerOverrides":{"shape":"EcsContainerOverrideList"}, + "Cpu":{"shape":"String"}, + "EphemeralStorage":{"shape":"EcsEphemeralStorage"}, + "ExecutionRoleArn":{"shape":"ArnOrJsonPath"}, + "InferenceAcceleratorOverrides":{"shape":"EcsInferenceAcceleratorOverrideList"}, + "Memory":{"shape":"String"}, + "TaskRoleArn":{"shape":"ArnOrJsonPath"} + } + }, + "EndpointString":{ + "type":"string", + "max":300, + "min":1, + "pattern":"^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]):[0-9]{1,5}$", + "sensitive":true + }, + "EphemeralStorageSize":{ + "type":"integer", + "max":200, + "min":21 + }, + "ErrorMessage":{"type":"string"}, + "EventBridgeDetailType":{ + "type":"string", + "max":128, + "min":1, + "sensitive":true + }, + "EventBridgeEndpointId":{ + "type":"string", + "max":50, + "min":1, + "pattern":"^[A-Za-z0-9\\-]+[\\.][A-Za-z0-9\\-]+|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)$", + "sensitive":true + }, + "EventBridgeEventResourceList":{ + "type":"list", + "member":{"shape":"ArnOrJsonPath"}, + "max":10, + "min":0 + }, + "EventBridgeEventSource":{ + "type":"string", + "max":256, + "min":1, + "pattern":"(?=[/\\.\\-_A-Za-z0-9]+)((?!aws\\.).*)|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)", + "sensitive":true + }, + "EventPattern":{ + "type":"string", + "max":4096, + "min":0, + "sensitive":true + }, + "Filter":{ + "type":"structure", + "members":{ + "Pattern":{"shape":"EventPattern"} + } + }, + "FilterCriteria":{ + "type":"structure", + "members":{ + "Filters":{"shape":"FilterList"} + } + }, + "FilterList":{ + "type":"list", + "member":{"shape":"Filter"}, + "max":5, + "min":0 + }, + "HeaderKey":{ + "type":"string", + "max":512, + "min":0, + "pattern":"^[!#$%&'*+-.^_`|~0-9a-zA-Z]+|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)$" + }, + "HeaderParametersMap":{ + "type":"map", + "key":{"shape":"HeaderKey"}, + "value":{"shape":"HeaderValue"} + }, + "HeaderValue":{ + "type":"string", + "max":512, + "min":0, + "pattern":"^[ \\t]*[\\x20-\\x7E]+([ \\t]+[\\x20-\\x7E]+)*[ \\t]*|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)$", + "sensitive":true + }, + "InputTemplate":{ + "type":"string", + "max":8192, + "min":0, + "sensitive":true + }, + "Integer":{ + "type":"integer", + "box":true + }, + "InternalException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"}, + "retryAfterSeconds":{ + "shape":"Integer", + "location":"header", + "locationName":"Retry-After" + } + }, + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "JsonPath":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*$" + }, + "KafkaBootstrapServers":{ + "type":"list", + "member":{"shape":"EndpointString"}, + "max":2, + "min":0 + }, + "KafkaTopicName":{ + "type":"string", + "max":249, + "min":1, + "pattern":"^[^.]([a-zA-Z0-9\\-_.]+)$", + "sensitive":true + }, + "KinesisPartitionKey":{ + "type":"string", + "max":256, + "min":0, + "sensitive":true + }, + "KinesisStreamStartPosition":{ + "type":"string", + "enum":[ + "TRIM_HORIZON", + "LATEST", + "AT_TIMESTAMP" + ] + }, + "LaunchType":{ + "type":"string", + "enum":[ + "EC2", + "FARGATE", + "EXTERNAL" + ] + }, + "LimitMax10":{ + "type":"integer", + "box":true, + "max":10, + "min":1 + }, + "LimitMax100":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "LimitMax1000":{ + "type":"integer", + "box":true, + "max":1000, + "min":1 + }, + "LimitMax10000":{ + "type":"integer", + "box":true, + "max":10000, + "min":1 + }, + "LimitMin1":{ + "type":"integer", + "box":true, + "min":1 + }, + "ListPipesRequest":{ + "type":"structure", + "members":{ + "CurrentState":{ + "shape":"PipeState", + "location":"querystring", + "locationName":"CurrentState" + }, + "DesiredState":{ + "shape":"RequestedPipeState", + "location":"querystring", + "locationName":"DesiredState" + }, + "Limit":{ + "shape":"LimitMax100", + "location":"querystring", + "locationName":"Limit" + }, + "NamePrefix":{ + "shape":"PipeName", + "location":"querystring", + "locationName":"NamePrefix" + }, + "NextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"NextToken" + }, + "SourcePrefix":{ + "shape":"ResourceArn", + "location":"querystring", + "locationName":"SourcePrefix" + }, + "TargetPrefix":{ + "shape":"ResourceArn", + "location":"querystring", + "locationName":"TargetPrefix" + } + } + }, + "ListPipesResponse":{ + "type":"structure", + "members":{ + "NextToken":{"shape":"NextToken"}, + "Pipes":{"shape":"PipeList"} + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"PipeArn", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "tags":{"shape":"TagMap"} + } + }, + "LogStreamName":{ + "type":"string", + "max":256, + "min":1 + }, + "MQBrokerAccessCredentials":{ + "type":"structure", + "members":{ + "BasicAuth":{"shape":"SecretManagerArn"} + }, + "union":true + }, + "MQBrokerQueueName":{ + "type":"string", + "max":1000, + "min":1, + "pattern":"^[\\s\\S]*$", + "sensitive":true + }, + "MSKAccessCredentials":{ + "type":"structure", + "members":{ + "ClientCertificateTlsAuth":{"shape":"SecretManagerArn"}, + "SaslScram512Auth":{"shape":"SecretManagerArn"} + }, + "union":true + }, + "MSKStartPosition":{ + "type":"string", + "enum":[ + "TRIM_HORIZON", + "LATEST" + ] + }, + "MaximumBatchingWindowInSeconds":{ + "type":"integer", + "box":true, + "max":300, + "min":0 + }, + "MaximumRecordAgeInSeconds":{ + "type":"integer", + "box":true, + "max":604800, + "min":-1 + }, + "MaximumRetryAttemptsESM":{ + "type":"integer", + "box":true, + "max":10000, + "min":-1 + }, + "MessageDeduplicationId":{ + "type":"string", + "max":100, + "min":0, + "sensitive":true + }, + "MessageGroupId":{ + "type":"string", + "max":100, + "min":0, + "sensitive":true + }, + "NetworkConfiguration":{ + "type":"structure", + "members":{ + "awsvpcConfiguration":{"shape":"AwsVpcConfiguration"} + } + }, + "NextToken":{ + "type":"string", + "max":2048, + "min":1, + "sensitive":true + }, + "NotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "OnPartialBatchItemFailureStreams":{ + "type":"string", + "enum":["AUTOMATIC_BISECT"] + }, + "OptionalArn":{ + "type":"string", + "max":1600, + "min":0, + "pattern":"^$|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.*)$" + }, + "PathParameter":{ + "type":"string", + "pattern":"^(?!\\s*$).+|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)$", + "sensitive":true + }, + "PathParameterList":{ + "type":"list", + "member":{"shape":"PathParameter"}, + "max":1, + "min":0 + }, + "Pipe":{ + "type":"structure", + "members":{ + "Arn":{"shape":"PipeArn"}, + "CreationTime":{"shape":"Timestamp"}, + "CurrentState":{"shape":"PipeState"}, + "DesiredState":{"shape":"RequestedPipeState"}, + "Enrichment":{"shape":"OptionalArn"}, + "LastModifiedTime":{"shape":"Timestamp"}, + "Name":{"shape":"PipeName"}, + "Source":{"shape":"ArnOrUrl"}, + "StateReason":{"shape":"PipeStateReason"}, + "Target":{"shape":"Arn"} + } + }, + "PipeArn":{ + "type":"string", + "max":1600, + "min":1, + "pattern":"^arn:aws([a-z]|\\-)*:([a-zA-Z0-9\\-]+):([a-z]|\\d|\\-)*:([0-9]{12})?:(.*)$" + }, + "PipeDescription":{ + "type":"string", + "max":512, + "min":0, + "pattern":"^.*$", + "sensitive":true + }, + "PipeEnrichmentHttpParameters":{ + "type":"structure", + "members":{ + "HeaderParameters":{"shape":"HeaderParametersMap"}, + "PathParameterValues":{"shape":"PathParameterList"}, + "QueryStringParameters":{"shape":"QueryStringParametersMap"} + } + }, + "PipeEnrichmentParameters":{ + "type":"structure", + "members":{ + "HttpParameters":{"shape":"PipeEnrichmentHttpParameters"}, + "InputTemplate":{"shape":"InputTemplate"} + } + }, + "PipeList":{ + "type":"list", + "member":{"shape":"Pipe"} + }, + "PipeName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[\\.\\-_A-Za-z0-9]+$" + }, + "PipeSourceActiveMQBrokerParameters":{ + "type":"structure", + "required":[ + "Credentials", + "QueueName" + ], + "members":{ + "BatchSize":{"shape":"LimitMax10000"}, + "Credentials":{"shape":"MQBrokerAccessCredentials"}, + "MaximumBatchingWindowInSeconds":{"shape":"MaximumBatchingWindowInSeconds"}, + "QueueName":{"shape":"MQBrokerQueueName"} + } + }, + "PipeSourceDynamoDBStreamParameters":{ + "type":"structure", + "required":["StartingPosition"], + "members":{ + "BatchSize":{"shape":"LimitMax1000"}, + "DeadLetterConfig":{"shape":"DeadLetterConfig"}, + "MaximumBatchingWindowInSeconds":{"shape":"MaximumBatchingWindowInSeconds"}, + "MaximumRecordAgeInSeconds":{"shape":"MaximumRecordAgeInSeconds"}, + "MaximumRetryAttempts":{"shape":"MaximumRetryAttemptsESM"}, + "OnPartialBatchItemFailure":{"shape":"OnPartialBatchItemFailureStreams"}, + "ParallelizationFactor":{"shape":"LimitMax10"}, + "StartingPosition":{"shape":"DynamoDBStreamStartPosition"} + } + }, + "PipeSourceKinesisStreamParameters":{ + "type":"structure", + "required":["StartingPosition"], + "members":{ + "BatchSize":{"shape":"LimitMax10000"}, + "DeadLetterConfig":{"shape":"DeadLetterConfig"}, + "MaximumBatchingWindowInSeconds":{"shape":"MaximumBatchingWindowInSeconds"}, + "MaximumRecordAgeInSeconds":{"shape":"MaximumRecordAgeInSeconds"}, + "MaximumRetryAttempts":{"shape":"MaximumRetryAttemptsESM"}, + "OnPartialBatchItemFailure":{"shape":"OnPartialBatchItemFailureStreams"}, + "ParallelizationFactor":{"shape":"LimitMax10"}, + "StartingPosition":{"shape":"KinesisStreamStartPosition"}, + "StartingPositionTimestamp":{"shape":"Timestamp"} + } + }, + "PipeSourceManagedStreamingKafkaParameters":{ + "type":"structure", + "required":["TopicName"], + "members":{ + "BatchSize":{"shape":"LimitMax10000"}, + "ConsumerGroupID":{"shape":"URI"}, + "Credentials":{"shape":"MSKAccessCredentials"}, + "MaximumBatchingWindowInSeconds":{"shape":"MaximumBatchingWindowInSeconds"}, + "StartingPosition":{"shape":"MSKStartPosition"}, + "TopicName":{"shape":"KafkaTopicName"} + } + }, + "PipeSourceParameters":{ + "type":"structure", + "members":{ + "ActiveMQBrokerParameters":{"shape":"PipeSourceActiveMQBrokerParameters"}, + "DynamoDBStreamParameters":{"shape":"PipeSourceDynamoDBStreamParameters"}, + "FilterCriteria":{"shape":"FilterCriteria"}, + "KinesisStreamParameters":{"shape":"PipeSourceKinesisStreamParameters"}, + "ManagedStreamingKafkaParameters":{"shape":"PipeSourceManagedStreamingKafkaParameters"}, + "RabbitMQBrokerParameters":{"shape":"PipeSourceRabbitMQBrokerParameters"}, + "SelfManagedKafkaParameters":{"shape":"PipeSourceSelfManagedKafkaParameters"}, + "SqsQueueParameters":{"shape":"PipeSourceSqsQueueParameters"} + } + }, + "PipeSourceRabbitMQBrokerParameters":{ + "type":"structure", + "required":[ + "Credentials", + "QueueName" + ], + "members":{ + "BatchSize":{"shape":"LimitMax10000"}, + "Credentials":{"shape":"MQBrokerAccessCredentials"}, + "MaximumBatchingWindowInSeconds":{"shape":"MaximumBatchingWindowInSeconds"}, + "QueueName":{"shape":"MQBrokerQueueName"}, + "VirtualHost":{"shape":"URI"} + } + }, + "PipeSourceSelfManagedKafkaParameters":{ + "type":"structure", + "required":["TopicName"], + "members":{ + "AdditionalBootstrapServers":{"shape":"KafkaBootstrapServers"}, + "BatchSize":{"shape":"LimitMax10000"}, + "ConsumerGroupID":{"shape":"URI"}, + "Credentials":{"shape":"SelfManagedKafkaAccessConfigurationCredentials"}, + "MaximumBatchingWindowInSeconds":{"shape":"MaximumBatchingWindowInSeconds"}, + "ServerRootCaCertificate":{"shape":"SecretManagerArn"}, + "StartingPosition":{"shape":"SelfManagedKafkaStartPosition"}, + "TopicName":{"shape":"KafkaTopicName"}, + "Vpc":{"shape":"SelfManagedKafkaAccessConfigurationVpc"} + } + }, + "PipeSourceSqsQueueParameters":{ + "type":"structure", + "members":{ + "BatchSize":{"shape":"LimitMax10000"}, + "MaximumBatchingWindowInSeconds":{"shape":"MaximumBatchingWindowInSeconds"} + } + }, + "PipeState":{ + "type":"string", + "enum":[ + "RUNNING", + "STOPPED", + "CREATING", + "UPDATING", + "DELETING", + "STARTING", + "STOPPING", + "CREATE_FAILED", + "UPDATE_FAILED", + "START_FAILED", + "STOP_FAILED" + ] + }, + "PipeStateReason":{ + "type":"string", + "max":512, + "min":0, + "pattern":"^.*$" + }, + "PipeTargetBatchJobParameters":{ + "type":"structure", + "required":[ + "JobDefinition", + "JobName" + ], + "members":{ + "ArrayProperties":{"shape":"BatchArrayProperties"}, + "ContainerOverrides":{"shape":"BatchContainerOverrides"}, + "DependsOn":{"shape":"BatchDependsOn"}, + "JobDefinition":{"shape":"String"}, + "JobName":{"shape":"String"}, + "Parameters":{"shape":"BatchParametersMap"}, + "RetryStrategy":{"shape":"BatchRetryStrategy"} + } + }, + "PipeTargetCloudWatchLogsParameters":{ + "type":"structure", + "members":{ + "LogStreamName":{"shape":"LogStreamName"}, + "Timestamp":{"shape":"JsonPath"} + } + }, + "PipeTargetEcsTaskParameters":{ + "type":"structure", + "required":["TaskDefinitionArn"], + "members":{ + "CapacityProviderStrategy":{"shape":"CapacityProviderStrategy"}, + "EnableECSManagedTags":{"shape":"Boolean"}, + "EnableExecuteCommand":{"shape":"Boolean"}, + "Group":{"shape":"String"}, + "LaunchType":{"shape":"LaunchType"}, + "NetworkConfiguration":{"shape":"NetworkConfiguration"}, + "Overrides":{"shape":"EcsTaskOverride"}, + "PlacementConstraints":{"shape":"PlacementConstraints"}, + "PlacementStrategy":{"shape":"PlacementStrategies"}, + "PlatformVersion":{"shape":"String"}, + "PropagateTags":{"shape":"PropagateTags"}, + "ReferenceId":{"shape":"ReferenceId"}, + "Tags":{"shape":"TagList"}, + "TaskCount":{"shape":"LimitMin1"}, + "TaskDefinitionArn":{"shape":"ArnOrJsonPath"} + } + }, + "PipeTargetEventBridgeEventBusParameters":{ + "type":"structure", + "members":{ + "DetailType":{"shape":"EventBridgeDetailType"}, + "EndpointId":{"shape":"EventBridgeEndpointId"}, + "Resources":{"shape":"EventBridgeEventResourceList"}, + "Source":{"shape":"EventBridgeEventSource"}, + "Time":{"shape":"JsonPath"} + } + }, + "PipeTargetHttpParameters":{ + "type":"structure", + "members":{ + "HeaderParameters":{"shape":"HeaderParametersMap"}, + "PathParameterValues":{"shape":"PathParameterList"}, + "QueryStringParameters":{"shape":"QueryStringParametersMap"} + } + }, + "PipeTargetInvocationType":{ + "type":"string", + "enum":[ + "REQUEST_RESPONSE", + "FIRE_AND_FORGET" + ] + }, + "PipeTargetKinesisStreamParameters":{ + "type":"structure", + "required":["PartitionKey"], + "members":{ + "PartitionKey":{"shape":"KinesisPartitionKey"} + } + }, + "PipeTargetLambdaFunctionParameters":{ + "type":"structure", + "members":{ + "InvocationType":{"shape":"PipeTargetInvocationType"} + } + }, + "PipeTargetParameters":{ + "type":"structure", + "members":{ + "BatchJobParameters":{"shape":"PipeTargetBatchJobParameters"}, + "CloudWatchLogsParameters":{"shape":"PipeTargetCloudWatchLogsParameters"}, + "EcsTaskParameters":{"shape":"PipeTargetEcsTaskParameters"}, + "EventBridgeEventBusParameters":{"shape":"PipeTargetEventBridgeEventBusParameters"}, + "HttpParameters":{"shape":"PipeTargetHttpParameters"}, + "InputTemplate":{"shape":"InputTemplate"}, + "KinesisStreamParameters":{"shape":"PipeTargetKinesisStreamParameters"}, + "LambdaFunctionParameters":{"shape":"PipeTargetLambdaFunctionParameters"}, + "RedshiftDataParameters":{"shape":"PipeTargetRedshiftDataParameters"}, + "SageMakerPipelineParameters":{"shape":"PipeTargetSageMakerPipelineParameters"}, + "SqsQueueParameters":{"shape":"PipeTargetSqsQueueParameters"}, + "StepFunctionStateMachineParameters":{"shape":"PipeTargetStateMachineParameters"} + } + }, + "PipeTargetRedshiftDataParameters":{ + "type":"structure", + "required":[ + "Database", + "Sqls" + ], + "members":{ + "Database":{"shape":"Database"}, + "DbUser":{"shape":"DbUser"}, + "SecretManagerArn":{"shape":"SecretManagerArnOrJsonPath"}, + "Sqls":{"shape":"Sqls"}, + "StatementName":{"shape":"StatementName"}, + "WithEvent":{"shape":"Boolean"} + } + }, + "PipeTargetSageMakerPipelineParameters":{ + "type":"structure", + "members":{ + "PipelineParameterList":{"shape":"SageMakerPipelineParameterList"} + } + }, + "PipeTargetSqsQueueParameters":{ + "type":"structure", + "members":{ + "MessageDeduplicationId":{"shape":"MessageDeduplicationId"}, + "MessageGroupId":{"shape":"MessageGroupId"} + } + }, + "PipeTargetStateMachineParameters":{ + "type":"structure", + "members":{ + "InvocationType":{"shape":"PipeTargetInvocationType"} + } + }, + "PlacementConstraint":{ + "type":"structure", + "members":{ + "expression":{"shape":"PlacementConstraintExpression"}, + "type":{"shape":"PlacementConstraintType"} + } + }, + "PlacementConstraintExpression":{ + "type":"string", + "max":2000, + "min":0, + "sensitive":true + }, + "PlacementConstraintType":{ + "type":"string", + "enum":[ + "distinctInstance", + "memberOf" + ] + }, + "PlacementConstraints":{ + "type":"list", + "member":{"shape":"PlacementConstraint"}, + "max":10, + "min":0 + }, + "PlacementStrategies":{ + "type":"list", + "member":{"shape":"PlacementStrategy"}, + "max":5, + "min":0 + }, + "PlacementStrategy":{ + "type":"structure", + "members":{ + "field":{"shape":"PlacementStrategyField"}, + "type":{"shape":"PlacementStrategyType"} + } + }, + "PlacementStrategyField":{ + "type":"string", + "max":255, + "min":0, + "sensitive":true + }, + "PlacementStrategyType":{ + "type":"string", + "enum":[ + "random", + "spread", + "binpack" + ] + }, + "PropagateTags":{ + "type":"string", + "enum":["TASK_DEFINITION"] + }, + "QueryStringKey":{ + "type":"string", + "max":512, + "min":0, + "pattern":"^[^\\x00-\\x1F\\x7F]+|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)$" + }, + "QueryStringParametersMap":{ + "type":"map", + "key":{"shape":"QueryStringKey"}, + "value":{"shape":"QueryStringValue"} + }, + "QueryStringValue":{ + "type":"string", + "max":512, + "min":0, + "pattern":"^[^\\x00-\\x09\\x0B\\x0C\\x0E-\\x1F\\x7F]+|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)$", + "sensitive":true + }, + "ReferenceId":{ + "type":"string", + "max":1024, + "min":0, + "sensitive":true + }, + "RequestedPipeState":{ + "type":"string", + "enum":[ + "RUNNING", + "STOPPED" + ] + }, + "RequestedPipeStateDescribeResponse":{ + "type":"string", + "enum":[ + "RUNNING", + "STOPPED", + "DELETED" + ] + }, + "ResourceArn":{ + "type":"string", + "max":1600, + "min":1 + }, + "RoleArn":{ + "type":"string", + "max":1600, + "min":1, + "pattern":"^arn:(aws[a-zA-Z-]*)?:iam::\\d{12}:role/?[a-zA-Z0-9+=,.@\\-_/]+$" + }, + "SageMakerPipelineParameter":{ + "type":"structure", + "required":[ + "Name", + "Value" + ], + "members":{ + "Name":{"shape":"SageMakerPipelineParameterName"}, + "Value":{"shape":"SageMakerPipelineParameterValue"} + } + }, + "SageMakerPipelineParameterList":{ + "type":"list", + "member":{"shape":"SageMakerPipelineParameter"}, + "max":200, + "min":0 + }, + "SageMakerPipelineParameterName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)$", + "sensitive":true + }, + "SageMakerPipelineParameterValue":{ + "type":"string", + "max":1024, + "min":0, + "sensitive":true + }, + "SecretManagerArn":{ + "type":"string", + "max":1600, + "min":1, + "pattern":"^(^arn:aws([a-z]|\\-)*:secretsmanager:[a-z0-9-.]+:.*)|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)$" + }, + "SecretManagerArnOrJsonPath":{ + "type":"string", + "max":1600, + "min":1, + "pattern":"^(^arn:aws([a-z]|\\-)*:secretsmanager:[a-z0-9-.]+:.*)|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)$" + }, + "SecurityGroup":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"^sg-[0-9a-zA-Z]*|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)$", + "sensitive":true + }, + "SecurityGroupId":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"^sg-[0-9a-zA-Z]*$", + "sensitive":true + }, + "SecurityGroupIds":{ + "type":"list", + "member":{"shape":"SecurityGroupId"}, + "max":5, + "min":0 + }, + "SecurityGroups":{ + "type":"list", + "member":{"shape":"SecurityGroup"}, + "max":5, + "min":0 + }, + "SelfManagedKafkaAccessConfigurationCredentials":{ + "type":"structure", + "members":{ + "BasicAuth":{"shape":"SecretManagerArn"}, + "ClientCertificateTlsAuth":{"shape":"SecretManagerArn"}, + "SaslScram256Auth":{"shape":"SecretManagerArn"}, + "SaslScram512Auth":{"shape":"SecretManagerArn"} + }, + "union":true + }, + "SelfManagedKafkaAccessConfigurationVpc":{ + "type":"structure", + "members":{ + "SecurityGroup":{"shape":"SecurityGroupIds"}, + "Subnets":{"shape":"SubnetIds"} + } + }, + "SelfManagedKafkaStartPosition":{ + "type":"string", + "enum":[ + "TRIM_HORIZON", + "LATEST" + ] + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "required":[ + "message", + "quotaCode", + "resourceId", + "resourceType", + "serviceCode" + ], + "members":{ + "message":{"shape":"String"}, + "quotaCode":{"shape":"String"}, + "resourceId":{"shape":"String"}, + "resourceType":{"shape":"String"}, + "serviceCode":{"shape":"String"} + }, + "error":{ + "httpStatusCode":402, + "senderFault":true + }, + "exception":true + }, + "Sql":{ + "type":"string", + "max":100000, + "min":1, + "sensitive":true + }, + "Sqls":{ + "type":"list", + "member":{"shape":"Sql"}, + "min":1 + }, + "StartPipeRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"PipeName", + "location":"uri", + "locationName":"Name" + } + } + }, + "StartPipeResponse":{ + "type":"structure", + "members":{ + "Arn":{"shape":"PipeArn"}, + "CreationTime":{"shape":"Timestamp"}, + "CurrentState":{"shape":"PipeState"}, + "DesiredState":{"shape":"RequestedPipeState"}, + "LastModifiedTime":{"shape":"Timestamp"}, + "Name":{"shape":"PipeName"} + } + }, + "StatementName":{ + "type":"string", + "max":500, + "min":1, + "sensitive":true + }, + "StopPipeRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"PipeName", + "location":"uri", + "locationName":"Name" + } + } + }, + "StopPipeResponse":{ + "type":"structure", + "members":{ + "Arn":{"shape":"PipeArn"}, + "CreationTime":{"shape":"Timestamp"}, + "CurrentState":{"shape":"PipeState"}, + "DesiredState":{"shape":"RequestedPipeState"}, + "LastModifiedTime":{"shape":"Timestamp"}, + "Name":{"shape":"PipeName"} + } + }, + "String":{"type":"string"}, + "StringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "Subnet":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"^subnet-[0-9a-z]*|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)$", + "sensitive":true + }, + "SubnetId":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"^subnet-[0-9a-z]*$", + "sensitive":true + }, + "SubnetIds":{ + "type":"list", + "member":{"shape":"SubnetId"}, + "max":16, + "min":0 + }, + "Subnets":{ + "type":"list", + "member":{"shape":"Subnet"}, + "max":16, + "min":0 + }, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{"shape":"TagKey"}, + "Value":{"shape":"TagValue"} + } + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":0 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "max":50, + "min":1 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"PipeArn", + "location":"uri", + "locationName":"resourceArn" + }, + "tags":{"shape":"TagMap"} + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0, + "sensitive":true + }, + "ThrottlingException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"}, + "quotaCode":{"shape":"String"}, + "retryAfterSeconds":{ + "shape":"Integer", + "location":"header", + "locationName":"Retry-After" + }, + "serviceCode":{"shape":"String"} + }, + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true + }, + "Timestamp":{"type":"timestamp"}, + "URI":{ + "type":"string", + "max":200, + "min":1, + "pattern":"^[a-zA-Z0-9-\\/*:_+=.@-]*$", + "sensitive":true + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"PipeArn", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeyList", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdatePipeRequest":{ + "type":"structure", + "required":[ + "Name", + "RoleArn" + ], + "members":{ + "Description":{"shape":"PipeDescription"}, + "DesiredState":{"shape":"RequestedPipeState"}, + "Enrichment":{"shape":"OptionalArn"}, + "EnrichmentParameters":{"shape":"PipeEnrichmentParameters"}, + "Name":{ + "shape":"PipeName", + "location":"uri", + "locationName":"Name" + }, + "RoleArn":{"shape":"RoleArn"}, + "SourceParameters":{"shape":"UpdatePipeSourceParameters"}, + "Target":{"shape":"Arn"}, + "TargetParameters":{"shape":"PipeTargetParameters"} + } + }, + "UpdatePipeResponse":{ + "type":"structure", + "members":{ + "Arn":{"shape":"PipeArn"}, + "CreationTime":{"shape":"Timestamp"}, + "CurrentState":{"shape":"PipeState"}, + "DesiredState":{"shape":"RequestedPipeState"}, + "LastModifiedTime":{"shape":"Timestamp"}, + "Name":{"shape":"PipeName"} + } + }, + "UpdatePipeSourceActiveMQBrokerParameters":{ + "type":"structure", + "required":["Credentials"], + "members":{ + "BatchSize":{"shape":"LimitMax10000"}, + "Credentials":{"shape":"MQBrokerAccessCredentials"}, + "MaximumBatchingWindowInSeconds":{"shape":"MaximumBatchingWindowInSeconds"} + } + }, + "UpdatePipeSourceDynamoDBStreamParameters":{ + "type":"structure", + "members":{ + "BatchSize":{"shape":"LimitMax1000"}, + "DeadLetterConfig":{"shape":"DeadLetterConfig"}, + "MaximumBatchingWindowInSeconds":{"shape":"MaximumBatchingWindowInSeconds"}, + "MaximumRecordAgeInSeconds":{"shape":"MaximumRecordAgeInSeconds"}, + "MaximumRetryAttempts":{"shape":"MaximumRetryAttemptsESM"}, + "OnPartialBatchItemFailure":{"shape":"OnPartialBatchItemFailureStreams"}, + "ParallelizationFactor":{"shape":"LimitMax10"} + } + }, + "UpdatePipeSourceKinesisStreamParameters":{ + "type":"structure", + "members":{ + "BatchSize":{"shape":"LimitMax10000"}, + "DeadLetterConfig":{"shape":"DeadLetterConfig"}, + "MaximumBatchingWindowInSeconds":{"shape":"MaximumBatchingWindowInSeconds"}, + "MaximumRecordAgeInSeconds":{"shape":"MaximumRecordAgeInSeconds"}, + "MaximumRetryAttempts":{"shape":"MaximumRetryAttemptsESM"}, + "OnPartialBatchItemFailure":{"shape":"OnPartialBatchItemFailureStreams"}, + "ParallelizationFactor":{"shape":"LimitMax10"} + } + }, + "UpdatePipeSourceManagedStreamingKafkaParameters":{ + "type":"structure", + "members":{ + "BatchSize":{"shape":"LimitMax10000"}, + "Credentials":{"shape":"MSKAccessCredentials"}, + "MaximumBatchingWindowInSeconds":{"shape":"MaximumBatchingWindowInSeconds"} + } + }, + "UpdatePipeSourceParameters":{ + "type":"structure", + "members":{ + "ActiveMQBrokerParameters":{"shape":"UpdatePipeSourceActiveMQBrokerParameters"}, + "DynamoDBStreamParameters":{"shape":"UpdatePipeSourceDynamoDBStreamParameters"}, + "FilterCriteria":{"shape":"FilterCriteria"}, + "KinesisStreamParameters":{"shape":"UpdatePipeSourceKinesisStreamParameters"}, + "ManagedStreamingKafkaParameters":{"shape":"UpdatePipeSourceManagedStreamingKafkaParameters"}, + "RabbitMQBrokerParameters":{"shape":"UpdatePipeSourceRabbitMQBrokerParameters"}, + "SelfManagedKafkaParameters":{"shape":"UpdatePipeSourceSelfManagedKafkaParameters"}, + "SqsQueueParameters":{"shape":"UpdatePipeSourceSqsQueueParameters"} + } + }, + "UpdatePipeSourceRabbitMQBrokerParameters":{ + "type":"structure", + "required":["Credentials"], + "members":{ + "BatchSize":{"shape":"LimitMax10000"}, + "Credentials":{"shape":"MQBrokerAccessCredentials"}, + "MaximumBatchingWindowInSeconds":{"shape":"MaximumBatchingWindowInSeconds"} + } + }, + "UpdatePipeSourceSelfManagedKafkaParameters":{ + "type":"structure", + "members":{ + "BatchSize":{"shape":"LimitMax10000"}, + "Credentials":{"shape":"SelfManagedKafkaAccessConfigurationCredentials"}, + "MaximumBatchingWindowInSeconds":{"shape":"MaximumBatchingWindowInSeconds"}, + "ServerRootCaCertificate":{"shape":"SecretManagerArn"}, + "Vpc":{"shape":"SelfManagedKafkaAccessConfigurationVpc"} + } + }, + "UpdatePipeSourceSqsQueueParameters":{ + "type":"structure", + "members":{ + "BatchSize":{"shape":"LimitMax10000"}, + "MaximumBatchingWindowInSeconds":{"shape":"MaximumBatchingWindowInSeconds"} + } + }, + "ValidationException":{ + "type":"structure", + "members":{ + "fieldList":{"shape":"ValidationExceptionFieldList"}, + "message":{"shape":"ErrorMessage"} + }, + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ValidationExceptionField":{ + "type":"structure", + "required":[ + "message", + "name" + ], + "members":{ + "message":{"shape":"ErrorMessage"}, + "name":{"shape":"String"} + } + }, + "ValidationExceptionFieldList":{ + "type":"list", + "member":{"shape":"ValidationExceptionField"} + } + }, + "xmlNamespace":"http://events.amazonaws.com/doc/2015-10-07" +} diff --git a/models/apis/pipes/2015-10-07/docs-2.json b/models/apis/pipes/2015-10-07/docs-2.json new file mode 100644 index 00000000000..a44697248d5 --- /dev/null +++ b/models/apis/pipes/2015-10-07/docs-2.json @@ -0,0 +1,1374 @@ +{ + "version": "2.0", + "service": "Amazon EventBridge Pipes connects event sources to targets. Pipes reduces the need for specialized knowledge and integration code when developing event driven architectures. This helps ensures consistency across your company’s applications. With Pipes, the target can be any available EventBridge target. To set up a pipe, you select the event source, add optional event filtering, define optional enrichment, and select the target for the event data.
", + "operations": { + "CreatePipe": "Create a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.
", + "DeletePipe": "Delete an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.
", + "DescribePipe": "Get the information about an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.
", + "ListPipes": "Get the pipes associated with this account. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.
", + "ListTagsForResource": "Displays the tags associated with a pipe.
", + "StartPipe": "Start an existing pipe.
", + "StopPipe": "Stop an existing pipe.
", + "TagResource": "Assigns one or more tags (key-value pairs) to the specified pipe. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can use the TagResource action with a pipe that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the pipe. If you specify a tag key that is already associated with the pipe, the new tag value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a pipe.
", + "UntagResource": "Removes one or more tags from the specified pipes.
", + "UpdatePipe": "Update an existing pipe. When you call UpdatePipe, only the fields that are included in the request are changed, the rest are unchanged. The exception to this is if you modify any Amazon Web Services-service specific fields in the SourceParameters, EnrichmentParameters, or TargetParameters objects. The fields in these objects are updated atomically as one and override existing values. This is by design and means that if you don't specify an optional field in one of these Parameters objects, that field will be set to its system-default value after the update.
<p>For more information about pipes, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html"> Amazon EventBridge Pipes</a> in the Amazon EventBridge User Guide.</p> The ARN of the target resource.
", + "DeadLetterConfig$Arn": "The ARN of the Amazon SQS queue specified as the target for the dead-letter queue.
", + "DescribePipeResponse$Target": "The ARN of the target resource.
", + "Pipe$Target": "The ARN of the target resource.
", + "UpdatePipeRequest$Target": "The ARN of the target resource.
" + } + }, + "ArnOrJsonPath": { + "base": null, + "refs": { + "EcsTaskOverride$ExecutionRoleArn": "The Amazon Resource Name (ARN) of the task execution IAM role override for the task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.
", + "EcsTaskOverride$TaskRoleArn": "The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. For more information, see IAM Role for Tasks in the Amazon Elastic Container Service Developer Guide.
", + "EventBridgeEventResourceList$member": null, + "PipeTargetEcsTaskParameters$TaskDefinitionArn": "The ARN of the task definition to use if the event target is an Amazon ECS task.
" + } + }, + "ArnOrUrl": { + "base": null, + "refs": { + "CreatePipeRequest$Source": "The ARN of the source resource.
", + "DescribePipeResponse$Source": "The ARN of the source resource.
", + "Pipe$Source": "The ARN of the source resource.
" + } + }, + "AssignPublicIp": { + "base": null, + "refs": { + "AwsVpcConfiguration$AssignPublicIp": "Specifies whether the task's elastic network interface receives a public IP address. You can specify ENABLED only when LaunchType in EcsParameters is set to FARGATE.
This structure specifies the VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode.
Use this structure to specify the VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode.
The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an Batch job.
", + "refs": { + "PipeTargetBatchJobParameters$ArrayProperties": "The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an Batch job.
" + } + }, + "BatchArraySize": { + "base": null, + "refs": { + "BatchArrayProperties$Size": "The size of the array, if this is an array batch job.
" + } + }, + "BatchContainerOverrides": { + "base": "The overrides that are sent to a container.
", + "refs": { + "PipeTargetBatchJobParameters$ContainerOverrides": "The overrides that are sent to a container.
" + } + }, + "BatchDependsOn": { + "base": null, + "refs": { + "PipeTargetBatchJobParameters$DependsOn": "A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.
The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition.
Environment variables cannot start with \"Batch\". This naming convention is reserved for variables that Batch sets.
The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition.
Environment variables cannot start with \"Batch\". This naming convention is reserved for variables that Batch sets.
An object that represents an Batch job dependency.
", + "refs": { + "BatchDependsOn$member": null + } + }, + "BatchJobDependencyType": { + "base": null, + "refs": { + "BatchJobDependency$Type": "The type of the job dependency.
" + } + }, + "BatchParametersMap": { + "base": null, + "refs": { + "PipeTargetBatchJobParameters$Parameters": "Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters included here override any corresponding parameter defaults from the job definition.
" + } + }, + "BatchResourceRequirement": { + "base": "The type and amount of a resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.
The type of resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.
The type and amount of resources to assign to a container. This overrides the settings in the job definition. The supported resources include GPU, MEMORY, and VCPU.
The number of times to move a job to the RUNNABLE status. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value.
The retry strategy that's associated with a job. For more information, see Automated job retries in the Batch User Guide.
", + "refs": { + "PipeTargetBatchJobParameters$RetryStrategy": "The retry strategy to use for failed jobs. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.
" + } + }, + "Boolean": { + "base": null, + "refs": { + "PipeTargetEcsTaskParameters$EnableECSManagedTags": "Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
", + "PipeTargetEcsTaskParameters$EnableExecuteCommand": "Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.
", + "PipeTargetRedshiftDataParameters$WithEvent": "Indicates whether to send an event back to EventBridge after the SQL statement runs.
" + } + }, + "CapacityProvider": { + "base": null, + "refs": { + "CapacityProviderStrategyItem$capacityProvider": "The short name of the capacity provider.
" + } + }, + "CapacityProviderStrategy": { + "base": null, + "refs": { + "PipeTargetEcsTaskParameters$CapacityProviderStrategy": "The capacity provider strategy to use for the task.
If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.
The details of a capacity provider strategy. To learn more, see CapacityProviderStrategyItem in the Amazon ECS API Reference.
", + "refs": { + "CapacityProviderStrategy$member": null + } + }, + "CapacityProviderStrategyItemBase": { + "base": null, + "refs": { + "CapacityProviderStrategyItem$base": "The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.
" + } + }, + "CapacityProviderStrategyItemWeight": { + "base": null, + "refs": { + "CapacityProviderStrategyItem$weight": "The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.
" + } + }, + "ConflictException": { + "base": "An action you attempted resulted in an exception.
", + "refs": { + } + }, + "CreatePipeRequest": { + "base": null, + "refs": { + } + }, + "CreatePipeResponse": { + "base": null, + "refs": { + } + }, + "Database": { + "base": "// Redshift Database
", + "refs": { + "PipeTargetRedshiftDataParameters$Database": "The name of the database. Required when authenticating using temporary credentials.
" + } + }, + "DbUser": { + "base": "// Database user name
", + "refs": { + "PipeTargetRedshiftDataParameters$DbUser": "The database user name. Required when authenticating using temporary credentials.
" + } + }, + "DeadLetterConfig": { + "base": "A DeadLetterConfig object that contains information about a dead-letter queue configuration.
Define the target queue to send dead-letter queue events to.
", + "PipeSourceKinesisStreamParameters$DeadLetterConfig": "Define the target queue to send dead-letter queue events to.
", + "UpdatePipeSourceDynamoDBStreamParameters$DeadLetterConfig": "Define the target queue to send dead-letter queue events to.
", + "UpdatePipeSourceKinesisStreamParameters$DeadLetterConfig": "Define the target queue to send dead-letter queue events to.
" + } + }, + "DeletePipeRequest": { + "base": null, + "refs": { + } + }, + "DeletePipeResponse": { + "base": null, + "refs": { + } + }, + "DescribePipeRequest": { + "base": null, + "refs": { + } + }, + "DescribePipeResponse": { + "base": null, + "refs": { + } + }, + "DynamoDBStreamStartPosition": { + "base": null, + "refs": { + "PipeSourceDynamoDBStreamParameters$StartingPosition": "(Streams only) The position in a stream from which to start reading.
" + } + }, + "EcsContainerOverride": { + "base": "The overrides that are sent to a container. An empty container override can be passed in. An example of an empty container override is {\"containerOverrides\": [ ] }. If a non-empty container override is specified, the name parameter must be included.
One or more container overrides that are sent to a task.
" + } + }, + "EcsEnvironmentFile": { + "base": "A list of files containing the environment variables to pass to a container. You can specify up to ten environment files. The file must have a .env file extension. Each line in an environment file should contain an environment variable in VARIABLE=VALUE format. Lines beginning with # are treated as comments and are ignored. For more information about the environment variable file syntax, see Declare default environment variables in file.
If there are environment variables specified using the environment parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see Specifying environment variables in the Amazon Elastic Container Service Developer Guide.
This parameter is only supported for tasks hosted on Fargate using the following platform versions:
Linux platform version 1.4.0 or later.
Windows platform version 1.0.0 or later.
A list of files containing the environment variables to pass to a container, instead of the value from the container definition.
" + } + }, + "EcsEnvironmentFileType": { + "base": null, + "refs": { + "EcsEnvironmentFile$type": "The file type to use. The only supported value is s3.
The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.
", + "refs": { + "EcsEnvironmentVariableList$member": null + } + }, + "EcsEnvironmentVariableList": { + "base": null, + "refs": { + "EcsContainerOverride$Environment": "The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.
" + } + }, + "EcsEphemeralStorage": { + "base": "The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate. For more information, see Fargate task storage in the Amazon ECS User Guide for Fargate.
This parameter is only supported for tasks hosted on Fargate using Linux platform version 1.4.0 or later. This parameter is not supported for Windows containers on Fargate.
The ephemeral storage setting override for the task.
This parameter is only supported for tasks hosted on Fargate that use the following platform versions:
Linux platform version 1.4.0 or later.
Windows platform version 1.0.0 or later.
Details on an Elastic Inference accelerator task override. This parameter is used to override the Elastic Inference accelerator specified in the task definition. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide.
", + "refs": { + "EcsInferenceAcceleratorOverrideList$member": null + } + }, + "EcsInferenceAcceleratorOverrideList": { + "base": null, + "refs": { + "EcsTaskOverride$InferenceAcceleratorOverrides": "The Elastic Inference accelerator override for the task.
" + } + }, + "EcsResourceRequirement": { + "base": "The type and amount of a resource to assign to a container. The supported resource types are GPUs and Elastic Inference accelerators. For more information, see Working with GPUs on Amazon ECS or Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide
", + "refs": { + "EcsResourceRequirementsList$member": null + } + }, + "EcsResourceRequirementType": { + "base": null, + "refs": { + "EcsResourceRequirement$type": "The type of resource to assign to a container. The supported values are GPU or InferenceAccelerator.
The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.
" + } + }, + "EcsTaskOverride": { + "base": "The overrides that are associated with a task.
", + "refs": { + "PipeTargetEcsTaskParameters$Overrides": "The overrides that are associated with a task.
" + } + }, + "EndpointString": { + "base": null, + "refs": { + "KafkaBootstrapServers$member": null + } + }, + "EphemeralStorageSize": { + "base": null, + "refs": { + "EcsEphemeralStorage$sizeInGiB": "The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is 21 GiB and the maximum supported value is 200 GiB.
The message of the exception.
" + } + }, + "EventBridgeDetailType": { + "base": null, + "refs": { + "PipeTargetEventBridgeEventBusParameters$DetailType": "A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.
" + } + }, + "EventBridgeEndpointId": { + "base": null, + "refs": { + "PipeTargetEventBridgeEventBusParameters$EndpointId": "The URL subdomain of the endpoint. For example, if the URL for Endpoint is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo.
When using Java, you must include auth-crt on the class path.
Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.
" + } + }, + "EventBridgeEventSource": { + "base": null, + "refs": { + "PipeTargetEventBridgeEventBusParameters$Source": "The source of the event.
" + } + }, + "EventPattern": { + "base": null, + "refs": { + "Filter$Pattern": "The event pattern.
" + } + }, + "Filter": { + "base": "Filter events using an event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
", + "refs": { + "FilterList$member": null + } + }, + "FilterCriteria": { + "base": "The collection of event patterns used to filter events. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
", + "refs": { + "PipeSourceParameters$FilterCriteria": "The collection of event patterns used to filter events. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
", + "UpdatePipeSourceParameters$FilterCriteria": "The collection of event patterns used to filter events. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
" + } + }, + "FilterList": { + "base": null, + "refs": { + "FilterCriteria$Filters": "The event patterns.
" + } + }, + "HeaderKey": { + "base": null, + "refs": { + "HeaderParametersMap$key": null + } + }, + "HeaderParametersMap": { + "base": null, + "refs": { + "PipeEnrichmentHttpParameters$HeaderParameters": "The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
", + "PipeTargetHttpParameters$HeaderParameters": "The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
" + } + }, + "HeaderValue": { + "base": null, + "refs": { + "HeaderParametersMap$value": null + } + }, + "InputTemplate": { + "base": null, + "refs": { + "PipeEnrichmentParameters$InputTemplate": "Valid JSON text passed to the enrichment. In this case, nothing from the event itself is passed to the enrichment. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format.
", + "PipeTargetParameters$InputTemplate": "Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format.
" + } + }, + "Integer": { + "base": null, + "refs": { + "EcsContainerOverride$Cpu": "The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.
The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.
", + "EcsContainerOverride$MemoryReservation": "The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.
", + "InternalException$retryAfterSeconds": "The number of seconds to wait before retrying the action that caused the exception.
", + "ThrottlingException$retryAfterSeconds": "The number of seconds to wait before retrying the action that caused the exception.
" + } + }, + "InternalException": { + "base": "This exception occurs due to unexpected causes.
", + "refs": { + } + }, + "JsonPath": { + "base": null, + "refs": { + "PipeTargetCloudWatchLogsParameters$Timestamp": "The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
", + "PipeTargetEventBridgeEventBusParameters$Time": "The time stamp of the event, per RFC3339. If no time stamp is provided, the time stamp of the PutEvents call is used.
" + } + }, + "KafkaBootstrapServers": { + "base": null, + "refs": { + "PipeSourceSelfManagedKafkaParameters$AdditionalBootstrapServers": "An array of server URLs.
" + } + }, + "KafkaTopicName": { + "base": null, + "refs": { + "PipeSourceManagedStreamingKafkaParameters$TopicName": "The name of the topic that the pipe will read from.
", + "PipeSourceSelfManagedKafkaParameters$TopicName": "The name of the topic that the pipe will read from.
" + } + }, + "KinesisPartitionKey": { + "base": null, + "refs": { + "PipeTargetKinesisStreamParameters$PartitionKey": "Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis Data Streams uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.
" + } + }, + "KinesisStreamStartPosition": { + "base": null, + "refs": { + "PipeSourceKinesisStreamParameters$StartingPosition": "(Streams only) The position in a stream from which to start reading.
" + } + }, + "LaunchType": { + "base": null, + "refs": { + "PipeTargetEcsTaskParameters$LaunchType": "Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The FARGATE value is supported only in the Regions where Fargate with Amazon ECS is supported. For more information, see Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide.
(Streams only) The number of batches to process concurrently from each shard. The default value is 1.
", + "PipeSourceKinesisStreamParameters$ParallelizationFactor": "(Streams only) The number of batches to process concurrently from each shard. The default value is 1.
", + "UpdatePipeSourceDynamoDBStreamParameters$ParallelizationFactor": "(Streams only) The number of batches to process concurrently from each shard. The default value is 1.
", + "UpdatePipeSourceKinesisStreamParameters$ParallelizationFactor": "(Streams only) The number of batches to process concurrently from each shard. The default value is 1.
" + } + }, + "LimitMax100": { + "base": null, + "refs": { + "ListPipesRequest$Limit": "The maximum number of pipes to include in the response.
" + } + }, + "LimitMax1000": { + "base": null, + "refs": { + "PipeSourceDynamoDBStreamParameters$BatchSize": "The maximum number of records to include in each batch.
", + "UpdatePipeSourceDynamoDBStreamParameters$BatchSize": "The maximum number of records to include in each batch.
" + } + }, + "LimitMax10000": { + "base": null, + "refs": { + "PipeSourceActiveMQBrokerParameters$BatchSize": "The maximum number of records to include in each batch.
", + "PipeSourceKinesisStreamParameters$BatchSize": "The maximum number of records to include in each batch.
", + "PipeSourceManagedStreamingKafkaParameters$BatchSize": "The maximum number of records to include in each batch.
", + "PipeSourceRabbitMQBrokerParameters$BatchSize": "The maximum number of records to include in each batch.
", + "PipeSourceSelfManagedKafkaParameters$BatchSize": "The maximum number of records to include in each batch.
", + "PipeSourceSqsQueueParameters$BatchSize": "The maximum number of records to include in each batch.
", + "UpdatePipeSourceActiveMQBrokerParameters$BatchSize": "The maximum number of records to include in each batch.
", + "UpdatePipeSourceKinesisStreamParameters$BatchSize": "The maximum number of records to include in each batch.
", + "UpdatePipeSourceManagedStreamingKafkaParameters$BatchSize": "The maximum number of records to include in each batch.
", + "UpdatePipeSourceRabbitMQBrokerParameters$BatchSize": "The maximum number of records to include in each batch.
", + "UpdatePipeSourceSelfManagedKafkaParameters$BatchSize": "The maximum number of records to include in each batch.
", + "UpdatePipeSourceSqsQueueParameters$BatchSize": "The maximum number of records to include in each batch.
" + } + }, + "LimitMin1": { + "base": null, + "refs": { + "PipeTargetEcsTaskParameters$TaskCount": "The number of tasks to create based on TaskDefinition. The default is 1.
The name of the log stream.
" + } + }, + "MQBrokerAccessCredentials": { + "base": "The Secrets Manager secret that stores your broker credentials.
", + "refs": { + "PipeSourceActiveMQBrokerParameters$Credentials": "The credentials needed to access the resource.
", + "PipeSourceRabbitMQBrokerParameters$Credentials": "The credentials needed to access the resource.
", + "UpdatePipeSourceActiveMQBrokerParameters$Credentials": "The credentials needed to access the resource.
", + "UpdatePipeSourceRabbitMQBrokerParameters$Credentials": "The credentials needed to access the resource.
" + } + }, + "MQBrokerQueueName": { + "base": null, + "refs": { + "PipeSourceActiveMQBrokerParameters$QueueName": "The name of the destination queue to consume.
", + "PipeSourceRabbitMQBrokerParameters$QueueName": "The name of the destination queue to consume.
" + } + }, + "MSKAccessCredentials": { + "base": "The Secrets Manager secret that stores your stream credentials.
", + "refs": { + "PipeSourceManagedStreamingKafkaParameters$Credentials": "The credentials needed to access the resource.
", + "UpdatePipeSourceManagedStreamingKafkaParameters$Credentials": "The credentials needed to access the resource.
" + } + }, + "MSKStartPosition": { + "base": null, + "refs": { + "PipeSourceManagedStreamingKafkaParameters$StartingPosition": "(Streams only) The position in a stream from which to start reading.
" + } + }, + "MaximumBatchingWindowInSeconds": { + "base": null, + "refs": { + "PipeSourceActiveMQBrokerParameters$MaximumBatchingWindowInSeconds": "The maximum length of a time to wait for events.
", + "PipeSourceDynamoDBStreamParameters$MaximumBatchingWindowInSeconds": "The maximum length of a time to wait for events.
", + "PipeSourceKinesisStreamParameters$MaximumBatchingWindowInSeconds": "The maximum length of a time to wait for events.
", + "PipeSourceManagedStreamingKafkaParameters$MaximumBatchingWindowInSeconds": "The maximum length of a time to wait for events.
", + "PipeSourceRabbitMQBrokerParameters$MaximumBatchingWindowInSeconds": "The maximum length of a time to wait for events.
", + "PipeSourceSelfManagedKafkaParameters$MaximumBatchingWindowInSeconds": "The maximum length of a time to wait for events.
", + "PipeSourceSqsQueueParameters$MaximumBatchingWindowInSeconds": "The maximum length of a time to wait for events.
", + "UpdatePipeSourceActiveMQBrokerParameters$MaximumBatchingWindowInSeconds": "The maximum length of a time to wait for events.
", + "UpdatePipeSourceDynamoDBStreamParameters$MaximumBatchingWindowInSeconds": "The maximum length of a time to wait for events.
", + "UpdatePipeSourceKinesisStreamParameters$MaximumBatchingWindowInSeconds": "The maximum length of a time to wait for events.
", + "UpdatePipeSourceManagedStreamingKafkaParameters$MaximumBatchingWindowInSeconds": "The maximum length of a time to wait for events.
", + "UpdatePipeSourceRabbitMQBrokerParameters$MaximumBatchingWindowInSeconds": "The maximum length of a time to wait for events.
", + "UpdatePipeSourceSelfManagedKafkaParameters$MaximumBatchingWindowInSeconds": "The maximum length of a time to wait for events.
", + "UpdatePipeSourceSqsQueueParameters$MaximumBatchingWindowInSeconds": "The maximum length of a time to wait for events.
" + } + }, + "MaximumRecordAgeInSeconds": { + "base": null, + "refs": { + "PipeSourceDynamoDBStreamParameters$MaximumRecordAgeInSeconds": "(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, EventBridge never discards old records.
", + "PipeSourceKinesisStreamParameters$MaximumRecordAgeInSeconds": "(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, EventBridge never discards old records.
", + "UpdatePipeSourceDynamoDBStreamParameters$MaximumRecordAgeInSeconds": "(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, EventBridge never discards old records.
", + "UpdatePipeSourceKinesisStreamParameters$MaximumRecordAgeInSeconds": "(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, EventBridge never discards old records.
" + } + }, + "MaximumRetryAttemptsESM": { + "base": null, + "refs": { + "PipeSourceDynamoDBStreamParameters$MaximumRetryAttempts": "(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.
", + "PipeSourceKinesisStreamParameters$MaximumRetryAttempts": "(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.
", + "UpdatePipeSourceDynamoDBStreamParameters$MaximumRetryAttempts": "(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.
", + "UpdatePipeSourceKinesisStreamParameters$MaximumRetryAttempts": "(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.
" + } + }, + "MessageDeduplicationId": { + "base": null, + "refs": { + "PipeTargetSqsQueueParameters$MessageDeduplicationId": "This parameter applies only to FIFO (first-in-first-out) queues.
The token used for deduplication of sent messages.
" + } + }, + "MessageGroupId": { + "base": null, + "refs": { + "PipeTargetSqsQueueParameters$MessageGroupId": "The FIFO message group ID to use as the target.
" + } + }, + "NetworkConfiguration": { + "base": "This structure specifies the network configuration for an Amazon ECS task.
", + "refs": { + "PipeTargetEcsTaskParameters$NetworkConfiguration": "Use this structure if the Amazon ECS task uses the awsvpc network mode. This structure specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used. This structure is required if LaunchType is FARGATE because the awsvpc mode is required for Fargate tasks.
If you specify NetworkConfiguration when the target ECS task does not use the awsvpc network mode, the task fails.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
An entity that you specified does not exist.
", + "refs": { + } + }, + "OnPartialBatchItemFailureStreams": { + "base": null, + "refs": { + "PipeSourceDynamoDBStreamParameters$OnPartialBatchItemFailure": "(Streams only) Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half until all the records are processed or there is one failed message left in the batch.
(Streams only) Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half until all the records are processed or there is one failed message left in the batch.
(Streams only) Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half until all the records are processed or there is one failed message left in the batch.
(Streams only) Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half until all the records are processed or there is one failed message left in the batch.
The ARN of the enrichment resource.
", + "DescribePipeResponse$Enrichment": "The ARN of the enrichment resource.
", + "Pipe$Enrichment": "The ARN of the enrichment resource.
", + "UpdatePipeRequest$Enrichment": "The ARN of the enrichment resource.
" + } + }, + "PathParameter": { + "base": null, + "refs": { + "PathParameterList$member": null + } + }, + "PathParameterList": { + "base": null, + "refs": { + "PipeEnrichmentHttpParameters$PathParameterValues": "The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards (\"*\").
", + "PipeTargetHttpParameters$PathParameterValues": "The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards (\"*\").
" + } + }, + "Pipe": { + "base": "An object that represents a pipe. Amazon EventBridgePipes connect event sources to targets and reduces the need for specialized knowledge and integration code.
", + "refs": { + "PipeList$member": null + } + }, + "PipeArn": { + "base": null, + "refs": { + "CreatePipeResponse$Arn": "The ARN of the pipe.
", + "DeletePipeResponse$Arn": "The ARN of the pipe.
", + "DescribePipeResponse$Arn": "The ARN of the pipe.
", + "ListTagsForResourceRequest$resourceArn": "The ARN of the pipe for which you want to view tags.
", + "Pipe$Arn": "The ARN of the pipe.
", + "StartPipeResponse$Arn": "The ARN of the pipe.
", + "StopPipeResponse$Arn": "The ARN of the pipe.
", + "TagResourceRequest$resourceArn": "The ARN of the pipe.
", + "UntagResourceRequest$resourceArn": "The ARN of the pipe.
", + "UpdatePipeResponse$Arn": "The ARN of the pipe.
" + } + }, + "PipeDescription": { + "base": null, + "refs": { + "CreatePipeRequest$Description": "A description of the pipe.
", + "DescribePipeResponse$Description": "A description of the pipe.
", + "UpdatePipeRequest$Description": "A description of the pipe.
" + } + }, + "PipeEnrichmentHttpParameters": { + "base": "These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations. In the latter case, these are merged with any InvocationParameters specified on the Connection, with any values from the Connection taking precedence.
", + "refs": { + "PipeEnrichmentParameters$HttpParameters": "Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.
If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values configured. In case of any conflicting keys, values from the Connection take precedence.
" + } + }, + "PipeEnrichmentParameters": { + "base": "The parameters required to set up enrichment on your pipe.
", + "refs": { + "CreatePipeRequest$EnrichmentParameters": "The parameters required to set up enrichment on your pipe.
", + "DescribePipeResponse$EnrichmentParameters": "The parameters required to set up enrichment on your pipe.
", + "UpdatePipeRequest$EnrichmentParameters": "The parameters required to set up enrichment on your pipe.
" + } + }, + "PipeList": { + "base": null, + "refs": { + "ListPipesResponse$Pipes": "The pipes returned by the call.
" + } + }, + "PipeName": { + "base": null, + "refs": { + "CreatePipeRequest$Name": "The name of the pipe.
", + "CreatePipeResponse$Name": "The name of the pipe.
", + "DeletePipeRequest$Name": "The name of the pipe.
", + "DeletePipeResponse$Name": "The name of the pipe.
", + "DescribePipeRequest$Name": "The name of the pipe.
", + "DescribePipeResponse$Name": "The name of the pipe.
", + "ListPipesRequest$NamePrefix": "A value that will return a subset of the pipes associated with this account. For example, \"NamePrefix\": \"ABC\" will return all endpoints with \"ABC\" in the name.
The name of the pipe.
", + "StartPipeRequest$Name": "The name of the pipe.
", + "StartPipeResponse$Name": "The name of the pipe.
", + "StopPipeRequest$Name": "The name of the pipe.
", + "StopPipeResponse$Name": "The name of the pipe.
", + "UpdatePipeRequest$Name": "The name of the pipe.
", + "UpdatePipeResponse$Name": "The name of the pipe.
" + } + }, + "PipeSourceActiveMQBrokerParameters": { + "base": "The parameters for using an Active MQ broker as a source.
", + "refs": { + "PipeSourceParameters$ActiveMQBrokerParameters": "The parameters for using an Active MQ broker as a source.
" + } + }, + "PipeSourceDynamoDBStreamParameters": { + "base": "The parameters for using a DynamoDB stream as a source.
", + "refs": { + "PipeSourceParameters$DynamoDBStreamParameters": "The parameters for using a DynamoDB stream as a source.
" + } + }, + "PipeSourceKinesisStreamParameters": { + "base": "The parameters for using a Kinesis stream as a source.
", + "refs": { + "PipeSourceParameters$KinesisStreamParameters": "The parameters for using a Kinesis stream as a source.
" + } + }, + "PipeSourceManagedStreamingKafkaParameters": { + "base": "The parameters for using an MSK stream as a source.
", + "refs": { + "PipeSourceParameters$ManagedStreamingKafkaParameters": "The parameters for using an MSK stream as a source.
" + } + }, + "PipeSourceParameters": { + "base": "The parameters required to set up a source for your pipe.
", + "refs": { + "CreatePipeRequest$SourceParameters": "The parameters required to set up a source for your pipe.
", + "DescribePipeResponse$SourceParameters": "The parameters required to set up a source for your pipe.
" + } + }, + "PipeSourceRabbitMQBrokerParameters": { + "base": "The parameters for using a Rabbit MQ broker as a source.
", + "refs": { + "PipeSourceParameters$RabbitMQBrokerParameters": "The parameters for using a Rabbit MQ broker as a source.
" + } + }, + "PipeSourceSelfManagedKafkaParameters": { + "base": "The parameters for using a self-managed Apache Kafka stream as a source.
", + "refs": { + "PipeSourceParameters$SelfManagedKafkaParameters": "The parameters for using a self-managed Apache Kafka stream as a source.
" + } + }, + "PipeSourceSqsQueueParameters": { + "base": "The parameters for using a Amazon SQS stream as a source.
", + "refs": { + "PipeSourceParameters$SqsQueueParameters": "The parameters for using a Amazon SQS stream as a source.
" + } + }, + "PipeState": { + "base": null, + "refs": { + "CreatePipeResponse$CurrentState": "The state the pipe is in.
", + "DeletePipeResponse$CurrentState": "The state the pipe is in.
", + "DescribePipeResponse$CurrentState": "The state the pipe is in.
", + "ListPipesRequest$CurrentState": "The state the pipe is in.
", + "Pipe$CurrentState": "The state the pipe is in.
", + "StartPipeResponse$CurrentState": "The state the pipe is in.
", + "StopPipeResponse$CurrentState": "The state the pipe is in.
", + "UpdatePipeResponse$CurrentState": "The state the pipe is in.
" + } + }, + "PipeStateReason": { + "base": null, + "refs": { + "DescribePipeResponse$StateReason": "The reason the pipe is in its current state.
", + "Pipe$StateReason": "The reason the pipe is in its current state.
" + } + }, + "PipeTargetBatchJobParameters": { + "base": "The parameters for using an Batch job as a target.
", + "refs": { + "PipeTargetParameters$BatchJobParameters": "The parameters for using an Batch job as a target.
" + } + }, + "PipeTargetCloudWatchLogsParameters": { + "base": "The parameters for using an CloudWatch Logs log stream as a target.
", + "refs": { + "PipeTargetParameters$CloudWatchLogsParameters": "The parameters for using an CloudWatch Logs log stream as a target.
" + } + }, + "PipeTargetEcsTaskParameters": { + "base": "The parameters for using an Amazon ECS task as a target.
", + "refs": { + "PipeTargetParameters$EcsTaskParameters": "The parameters for using an Amazon ECS task as a target.
" + } + }, + "PipeTargetEventBridgeEventBusParameters": { + "base": "The parameters for using an EventBridge event bus as a target.
", + "refs": { + "PipeTargetParameters$EventBridgeEventBusParameters": "The parameters for using an EventBridge event bus as a target.
" + } + }, + "PipeTargetHttpParameters": { + "base": "These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.
", + "refs": { + "PipeTargetParameters$HttpParameters": "These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.
" + } + }, + "PipeTargetInvocationType": { + "base": null, + "refs": { + "PipeTargetLambdaFunctionParameters$InvocationType": "Choose from the following options.
RequestResponse (default) - Invoke the function synchronously. Keep the connection open until the function returns a response or times out. The API response includes the function response and additional data.
Event - Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if it's configured). The API response only includes a status code.
DryRun - Validate parameter values and verify that the user or role has permission to invoke the function.
Specify whether to wait for the state machine to finish or not.
" + } + }, + "PipeTargetKinesisStreamParameters": { + "base": "The parameters for using a Kinesis stream as a source.
", + "refs": { + "PipeTargetParameters$KinesisStreamParameters": "The parameters for using a Kinesis stream as a source.
" + } + }, + "PipeTargetLambdaFunctionParameters": { + "base": "The parameters for using a Lambda function as a target.
", + "refs": { + "PipeTargetParameters$LambdaFunctionParameters": "The parameters for using a Lambda function as a target.
" + } + }, + "PipeTargetParameters": { + "base": "The parameters required to set up a target for your pipe.
", + "refs": { + "CreatePipeRequest$TargetParameters": "The parameters required to set up a target for your pipe.
", + "DescribePipeResponse$TargetParameters": "The parameters required to set up a target for your pipe.
", + "UpdatePipeRequest$TargetParameters": "The parameters required to set up a target for your pipe.
" + } + }, + "PipeTargetRedshiftDataParameters": { + "base": "These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API ExecuteStatement.
", + "refs": { + "PipeTargetParameters$RedshiftDataParameters": "These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API ExecuteStatement.
" + } + }, + "PipeTargetSageMakerPipelineParameters": { + "base": "The parameters for using a SageMaker pipeline as a target.
", + "refs": { + "PipeTargetParameters$SageMakerPipelineParameters": "The parameters for using a SageMaker pipeline as a target.
" + } + }, + "PipeTargetSqsQueueParameters": { + "base": "The parameters for using a Amazon SQS stream as a source.
", + "refs": { + "PipeTargetParameters$SqsQueueParameters": "The parameters for using a Amazon SQS stream as a source.
" + } + }, + "PipeTargetStateMachineParameters": { + "base": "The parameters for using a Step Functions state machine as a target.
", + "refs": { + "PipeTargetParameters$StepFunctionStateMachineParameters": "The parameters for using a Step Functions state machine as a target.
" + } + }, + "PlacementConstraint": { + "base": "An object representing a constraint on task placement. To learn more, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.
", + "refs": { + "PlacementConstraints$member": null + } + }, + "PlacementConstraintExpression": { + "base": null, + "refs": { + "PlacementConstraint$expression": "A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance. To learn more, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates.
" + } + }, + "PlacementConstraints": { + "base": null, + "refs": { + "PipeTargetEcsTaskParameters$PlacementConstraints": "An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).
" + } + }, + "PlacementStrategies": { + "base": null, + "refs": { + "PipeTargetEcsTaskParameters$PlacementStrategy": "The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
" + } + }, + "PlacementStrategy": { + "base": "The task placement strategy for a task or service. To learn more, see Task Placement Strategies in the Amazon Elastic Container Service Service Developer Guide.
", + "refs": { + "PlacementStrategies$member": null + } + }, + "PlacementStrategyField": { + "base": null, + "refs": { + "PlacementStrategy$field": "The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.
" + } + }, + "PlacementStrategyType": { + "base": null, + "refs": { + "PlacementStrategy$type": "The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).
" + } + }, + "PropagateTags": { + "base": null, + "refs": { + "PipeTargetEcsTaskParameters$PropagateTags": "Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.
The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
", + "PipeTargetHttpParameters$QueryStringParameters": "The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
" + } + }, + "QueryStringValue": { + "base": null, + "refs": { + "QueryStringParametersMap$value": null + } + }, + "ReferenceId": { + "base": null, + "refs": { + "PipeTargetEcsTaskParameters$ReferenceId": "The reference ID to use for the task.
" + } + }, + "RequestedPipeState": { + "base": null, + "refs": { + "CreatePipeRequest$DesiredState": "The state the pipe should be in.
", + "CreatePipeResponse$DesiredState": "The state the pipe should be in.
", + "ListPipesRequest$DesiredState": "The state the pipe should be in.
", + "Pipe$DesiredState": "The state the pipe should be in.
", + "StartPipeResponse$DesiredState": "The state the pipe should be in.
", + "StopPipeResponse$DesiredState": "The state the pipe should be in.
", + "UpdatePipeRequest$DesiredState": "The state the pipe should be in.
", + "UpdatePipeResponse$DesiredState": "The state the pipe should be in.
" + } + }, + "RequestedPipeStateDescribeResponse": { + "base": null, + "refs": { + "DeletePipeResponse$DesiredState": "The state the pipe should be in.
", + "DescribePipeResponse$DesiredState": "The state the pipe should be in.
" + } + }, + "ResourceArn": { + "base": null, + "refs": { + "ListPipesRequest$SourcePrefix": "The prefix matching the pipe source.
", + "ListPipesRequest$TargetPrefix": "The prefix matching the pipe target.
" + } + }, + "RoleArn": { + "base": null, + "refs": { + "CreatePipeRequest$RoleArn": "The ARN of the role that allows the pipe to send data to the target.
", + "DescribePipeResponse$RoleArn": "The ARN of the role that allows the pipe to send data to the target.
", + "UpdatePipeRequest$RoleArn": "The ARN of the role that allows the pipe to send data to the target.
" + } + }, + "SageMakerPipelineParameter": { + "base": "Name/Value pair of a parameter to start execution of a SageMaker Model Building Pipeline.
", + "refs": { + "SageMakerPipelineParameterList$member": null + } + }, + "SageMakerPipelineParameterList": { + "base": null, + "refs": { + "PipeTargetSageMakerPipelineParameters$PipelineParameterList": "List of Parameter names and values for SageMaker Model Building Pipeline execution.
" + } + }, + "SageMakerPipelineParameterName": { + "base": null, + "refs": { + "SageMakerPipelineParameter$Name": "Name of parameter to start execution of a SageMaker Model Building Pipeline.
" + } + }, + "SageMakerPipelineParameterValue": { + "base": null, + "refs": { + "SageMakerPipelineParameter$Value": "Value of parameter to start execution of a SageMaker Model Building Pipeline.
" + } + }, + "SecretManagerArn": { + "base": "// Optional SecretManager ARN which stores the database credentials
", + "refs": { + "MQBrokerAccessCredentials$BasicAuth": "The ARN of the Secrets Manager secret.
", + "MSKAccessCredentials$ClientCertificateTlsAuth": "The ARN of the Secrets Manager secret.
", + "MSKAccessCredentials$SaslScram512Auth": "The ARN of the Secrets Manager secret.
", + "PipeSourceSelfManagedKafkaParameters$ServerRootCaCertificate": "The ARN of the Secrets Manager secret used for certification.
", + "SelfManagedKafkaAccessConfigurationCredentials$BasicAuth": "The ARN of the Secrets Manager secret.
", + "SelfManagedKafkaAccessConfigurationCredentials$ClientCertificateTlsAuth": "The ARN of the Secrets Manager secret.
", + "SelfManagedKafkaAccessConfigurationCredentials$SaslScram256Auth": "The ARN of the Secrets Manager secret.
", + "SelfManagedKafkaAccessConfigurationCredentials$SaslScram512Auth": "The ARN of the Secrets Manager secret.
", + "UpdatePipeSourceSelfManagedKafkaParameters$ServerRootCaCertificate": "The ARN of the Secrets Manager secret used for certification.
" + } + }, + "SecretManagerArnOrJsonPath": { + "base": "// For targets, can either specify an ARN or a jsonpath pointing to the ARN.
", + "refs": { + "PipeTargetRedshiftDataParameters$SecretManagerArn": "The name or ARN of the secret that enables access to the database. Required when authenticating using SageMaker.
" + } + }, + "SecurityGroup": { + "base": null, + "refs": { + "SecurityGroups$member": null + } + }, + "SecurityGroupId": { + "base": null, + "refs": { + "SecurityGroupIds$member": null + } + }, + "SecurityGroupIds": { + "base": "List of SecurityGroupId.
", + "refs": { + "SelfManagedKafkaAccessConfigurationVpc$SecurityGroup": "Specifies the security groups associated with the stream. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used.
" + } + }, + "SecurityGroups": { + "base": null, + "refs": { + "AwsVpcConfiguration$SecurityGroups": "Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used.
" + } + }, + "SelfManagedKafkaAccessConfigurationCredentials": { + "base": "The Secrets Manager secret that stores your stream credentials.
", + "refs": { + "PipeSourceSelfManagedKafkaParameters$Credentials": "The credentials needed to access the resource.
", + "UpdatePipeSourceSelfManagedKafkaParameters$Credentials": "The credentials needed to access the resource.
" + } + }, + "SelfManagedKafkaAccessConfigurationVpc": { + "base": "This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.
", + "refs": { + "PipeSourceSelfManagedKafkaParameters$Vpc": "This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.
", + "UpdatePipeSourceSelfManagedKafkaParameters$Vpc": "This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.
" + } + }, + "SelfManagedKafkaStartPosition": { + "base": null, + "refs": { + "PipeSourceSelfManagedKafkaParameters$StartingPosition": "(Streams only) The position in a stream from which to start reading.
" + } + }, + "ServiceQuotaExceededException": { + "base": "A quota has been exceeded.
", + "refs": { + } + }, + "Sql": { + "base": "// A single Redshift SQL
", + "refs": { + "Sqls$member": null + } + }, + "Sqls": { + "base": "// A list of SQLs.
", + "refs": { + "PipeTargetRedshiftDataParameters$Sqls": "The SQL statement text to run.
" + } + }, + "StartPipeRequest": { + "base": null, + "refs": { + } + }, + "StartPipeResponse": { + "base": null, + "refs": { + } + }, + "StatementName": { + "base": "// A name for Redshift DataAPI statement which can be used as filter of // ListStatement.
", + "refs": { + "PipeTargetRedshiftDataParameters$StatementName": "The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
" + } + }, + "StopPipeRequest": { + "base": null, + "refs": { + } + }, + "StopPipeResponse": { + "base": null, + "refs": { + } + }, + "String": { + "base": null, + "refs": { + "BatchContainerOverrides$InstanceType": "The instance type to use for a multi-node parallel job.
This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.
The name of the key-value pair. For environment variables, this is the name of the environment variable.
", + "BatchEnvironmentVariable$Value": "The value of the key-value pair. For environment variables, this is the value of the environment variable.
", + "BatchJobDependency$JobId": "The job ID of the Batch job that's associated with this dependency.
", + "BatchParametersMap$key": null, + "BatchParametersMap$value": null, + "BatchResourceRequirement$Value": "The quantity of the specified resource to reserve for the container. The values vary based on the type specified.
The number of physical GPUs to reserve for the container. Make sure that the number of GPUs reserved for all containers in a job doesn't exceed the number of available GPUs on the compute resource that the job is launched on.
GPUs aren't available for jobs that are running on Fargate resources.
The memory hard limit (in MiB) present to the container. This parameter is supported for jobs that are running on EC2 resources. If your container attempts to exceed the memory specified, the container is terminated. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.
If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory management in the Batch User Guide.
For jobs that are running on Fargate resources, then value is the hard limit (in MiB), and must match one of the supported values and the VCPU values must be one of the values supported for that memory value.
VCPU = 0.25
VCPU = 0.25 or 0.5
VCPU = 0.25, 0.5, or 1
VCPU = 0.5, or 1
VCPU = 0.5, 1, or 2
VCPU = 1 or 2
VCPU = 1, 2, 4, or 8
VCPU = 2 or 4
VCPU = 2, 4, or 8
VCPU = 4
VCPU = 4 or 8
VCPU = 8
VCPU = 8 or 16
VCPU = 16
The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. For EC2 resources, you must specify at least one vCPU. This is required but can be specified in several places; it must be specified for each node at least once.
The default for the Fargate On-Demand vCPU resource count quota is 6 vCPUs. For more information about Fargate quotas, see Fargate quotas in the Amazon Web Services General Reference.
For jobs that are running on Fargate resources, then value must match one of the supported values and the MEMORY values must be one of the values supported for that VCPU value. The supported values are 0.25, 0.5, 1, 2, 4, 8, and 16
MEMORY = 512, 1024, or 2048
MEMORY = 1024, 2048, 3072, or 4096
MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192
MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384
MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720
MEMORY = 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344, or 61440
MEMORY = 32768, 40960, 49152, 57344, 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880
The ID of the resource that caused the exception.
", + "ConflictException$resourceType": "The type of resource that caused the exception.
", + "EcsContainerOverride$Name": "The name of the container that receives the override. This parameter is required if any override is specified.
", + "EcsEnvironmentFile$value": "The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.
", + "EcsEnvironmentVariable$name": "The name of the key-value pair. For environment variables, this is the name of the environment variable.
", + "EcsEnvironmentVariable$value": "The value of the key-value pair. For environment variables, this is the value of the environment variable.
", + "EcsInferenceAcceleratorOverride$deviceName": "The Elastic Inference accelerator device name to override for the task. This parameter must match a deviceName specified in the task definition.
The Elastic Inference accelerator type to use.
", + "EcsResourceRequirement$value": "The value for the specified resource type.
If the GPU type is used, the value is the number of physical GPUs the Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on.
If the InferenceAccelerator type is used, the value matches the deviceName for an InferenceAccelerator specified in a task definition.
The cpu override for the task.
", + "EcsTaskOverride$Memory": "The memory override for the task.
", + "InternalException$message": null, + "PipeTargetBatchJobParameters$JobDefinition": "The job definition used by this job. This value can be one of name, name:revision, or the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active revision is used.
The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
", + "PipeTargetEcsTaskParameters$Group": "Specifies an Amazon ECS task group for the task. The maximum length is 255 characters.
", + "PipeTargetEcsTaskParameters$PlatformVersion": "Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0.
This structure is used only if LaunchType is FARGATE. For more information about valid platform versions, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
The identifier of the quota that caused the exception.
", + "ServiceQuotaExceededException$resourceId": "The ID of the resource that caused the exception.
", + "ServiceQuotaExceededException$resourceType": "The type of resource that caused the exception.
", + "ServiceQuotaExceededException$serviceCode": "The identifier of the service that caused the exception.
", + "StringList$member": null, + "ThrottlingException$message": null, + "ThrottlingException$quotaCode": "The identifier of the quota that caused the exception.
", + "ThrottlingException$serviceCode": "The identifier of the service that caused the exception.
", + "ValidationExceptionField$name": "The name of the exception.
" + } + }, + "StringList": { + "base": null, + "refs": { + "BatchContainerOverrides$Command": "The command to send to the container that overrides the default command from the Docker image or the task definition.
", + "EcsContainerOverride$Command": "The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.
" + } + }, + "Subnet": { + "base": null, + "refs": { + "Subnets$member": null + } + }, + "SubnetId": { + "base": null, + "refs": { + "SubnetIds$member": null + } + }, + "SubnetIds": { + "base": "List of SubnetId.
", + "refs": { + "SelfManagedKafkaAccessConfigurationVpc$Subnets": "Specifies the subnets associated with the stream. These subnets must all be in the same VPC. You can specify as many as 16 subnets.
" + } + }, + "Subnets": { + "base": null, + "refs": { + "AwsVpcConfiguration$Subnets": "Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.
" + } + }, + "Tag": { + "base": "A key-value pair associated with an Amazon Web Services resource. In EventBridge, rules and event buses support tagging.
", + "refs": { + "TagList$member": null + } + }, + "TagKey": { + "base": null, + "refs": { + "Tag$Key": "A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.
", + "TagKeyList$member": null, + "TagMap$key": null + } + }, + "TagKeyList": { + "base": null, + "refs": { + "UntagResourceRequest$tagKeys": "The list of tag keys to remove from the pipe.
" + } + }, + "TagList": { + "base": null, + "refs": { + "PipeTargetEcsTaskParameters$Tags": "The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. To learn more, see RunTask in the Amazon ECS API Reference.
" + } + }, + "TagMap": { + "base": null, + "refs": { + "CreatePipeRequest$Tags": "The list of key-value pairs to associate with the pipe.
", + "DescribePipeResponse$Tags": "The list of key-value pairs to associate with the pipe.
", + "ListTagsForResourceResponse$tags": "The list of key-value pairs to associate with the pipe.
", + "TagResourceRequest$tags": "The list of key-value pairs associated with the pipe.
" + } + }, + "TagResourceRequest": { + "base": null, + "refs": { + } + }, + "TagResourceResponse": { + "base": null, + "refs": { + } + }, + "TagValue": { + "base": null, + "refs": { + "Tag$Value": "The value for the specified tag key.
", + "TagMap$value": null + } + }, + "ThrottlingException": { + "base": "An action was throttled.
", + "refs": { + } + }, + "Timestamp": { + "base": null, + "refs": { + "CreatePipeResponse$CreationTime": "The time the pipe was created.
", + "CreatePipeResponse$LastModifiedTime": "When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
", + "DeletePipeResponse$CreationTime": "The time the pipe was created.
", + "DeletePipeResponse$LastModifiedTime": "When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
", + "DescribePipeResponse$CreationTime": "The time the pipe was created.
", + "DescribePipeResponse$LastModifiedTime": "When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
", + "Pipe$CreationTime": "The time the pipe was created.
", + "Pipe$LastModifiedTime": "When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
", + "PipeSourceKinesisStreamParameters$StartingPositionTimestamp": "With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.
The time the pipe was created.
", + "StartPipeResponse$LastModifiedTime": "When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
", + "StopPipeResponse$CreationTime": "The time the pipe was created.
", + "StopPipeResponse$LastModifiedTime": "When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
", + "UpdatePipeResponse$CreationTime": "The time the pipe was created.
", + "UpdatePipeResponse$LastModifiedTime": "When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
" + } + }, + "URI": { + "base": null, + "refs": { + "PipeSourceManagedStreamingKafkaParameters$ConsumerGroupID": "The name of the destination queue to consume.
", + "PipeSourceRabbitMQBrokerParameters$VirtualHost": "The name of the virtual host associated with the source broker.
", + "PipeSourceSelfManagedKafkaParameters$ConsumerGroupID": "The name of the destination queue to consume.
" + } + }, + "UntagResourceRequest": { + "base": null, + "refs": { + } + }, + "UntagResourceResponse": { + "base": null, + "refs": { + } + }, + "UpdatePipeRequest": { + "base": null, + "refs": { + } + }, + "UpdatePipeResponse": { + "base": null, + "refs": { + } + }, + "UpdatePipeSourceActiveMQBrokerParameters": { + "base": "The parameters for using an Active MQ broker as a source.
", + "refs": { + "UpdatePipeSourceParameters$ActiveMQBrokerParameters": "The parameters for using an Active MQ broker as a source.
" + } + }, + "UpdatePipeSourceDynamoDBStreamParameters": { + "base": "The parameters for using a DynamoDB stream as a source.
", + "refs": { + "UpdatePipeSourceParameters$DynamoDBStreamParameters": "The parameters for using a DynamoDB stream as a source.
" + } + }, + "UpdatePipeSourceKinesisStreamParameters": { + "base": "The parameters for using a Kinesis stream as a source.
", + "refs": { + "UpdatePipeSourceParameters$KinesisStreamParameters": "The parameters for using a Kinesis stream as a source.
" + } + }, + "UpdatePipeSourceManagedStreamingKafkaParameters": { + "base": "The parameters for using an MSK stream as a source.
", + "refs": { + "UpdatePipeSourceParameters$ManagedStreamingKafkaParameters": "The parameters for using an MSK stream as a source.
" + } + }, + "UpdatePipeSourceParameters": { + "base": "The parameters required to set up a source for your pipe.
", + "refs": { + "UpdatePipeRequest$SourceParameters": "The parameters required to set up a source for your pipe.
" + } + }, + "UpdatePipeSourceRabbitMQBrokerParameters": { + "base": "The parameters for using a Rabbit MQ broker as a source.
", + "refs": { + "UpdatePipeSourceParameters$RabbitMQBrokerParameters": "The parameters for using a Rabbit MQ broker as a source.
" + } + }, + "UpdatePipeSourceSelfManagedKafkaParameters": { + "base": "The parameters for using a self-managed Apache Kafka stream as a source.
", + "refs": { + "UpdatePipeSourceParameters$SelfManagedKafkaParameters": "The parameters for using a self-managed Apache Kafka stream as a source.
" + } + }, + "UpdatePipeSourceSqsQueueParameters": { + "base": "The parameters for using a Amazon SQS stream as a source.
", + "refs": { + "UpdatePipeSourceParameters$SqsQueueParameters": "The parameters for using a Amazon SQS stream as a source.
" + } + }, + "ValidationException": { + "base": "Indicates that an error has occurred while performing a validate operation.
", + "refs": { + } + }, + "ValidationExceptionField": { + "base": "Indicates that an error has occurred while performing a validate operation.
", + "refs": { + "ValidationExceptionFieldList$member": null + } + }, + "ValidationExceptionFieldList": { + "base": null, + "refs": { + "ValidationException$fieldList": "The list of fields for which validation failed and the corresponding failure messages.
" + } + } + } +} diff --git a/models/apis/pipes/2015-10-07/endpoint-rule-set-1.json b/models/apis/pipes/2015-10-07/endpoint-rule-set-1.json new file mode 100644 index 00000000000..4872229c5cc --- /dev/null +++ b/models/apis/pipes/2015-10-07/endpoint-rule-set-1.json @@ -0,0 +1,309 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": true, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://pipes-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://pipes-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://pipes.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://pipes.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] +} \ No newline at end of file diff --git a/models/apis/pipes/2015-10-07/endpoint-tests-1.json b/models/apis/pipes/2015-10-07/endpoint-tests-1.json new file mode 100644 index 00000000000..6fbff86af97 --- /dev/null +++ b/models/apis/pipes/2015-10-07/endpoint-tests-1.json @@ -0,0 +1,295 @@ +{ + "testCases": [ + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://pipes-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://pipes-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://pipes.us-gov-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://pipes.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://pipes-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://pipes-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://pipes.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://pipes.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://pipes-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://pipes.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://pipes-fips.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://pipes-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://pipes.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://pipes.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://pipes-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://pipes.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" +} \ No newline at end of file diff --git a/models/apis/pipes/2015-10-07/examples-1.json b/models/apis/pipes/2015-10-07/examples-1.json new file mode 100644 index 00000000000..0ea7e3b0bbe --- /dev/null +++ b/models/apis/pipes/2015-10-07/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/models/apis/pipes/2015-10-07/paginators-1.json b/models/apis/pipes/2015-10-07/paginators-1.json new file mode 100644 index 00000000000..4663077cb45 --- /dev/null +++ b/models/apis/pipes/2015-10-07/paginators-1.json @@ -0,0 +1,10 @@ +{ + "pagination": { + "ListPipes": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "Limit", + "result_key": "Pipes" + } + } +} diff --git a/models/apis/states/2016-11-23/api-2.json b/models/apis/states/2016-11-23/api-2.json index 839c7af6c0d..569eda5cdc9 100644 --- a/models/apis/states/2016-11-23/api-2.json +++ b/models/apis/states/2016-11-23/api-2.json @@ -71,7 +71,8 @@ "input":{"shape":"DeleteStateMachineInput"}, "output":{"shape":"DeleteStateMachineOutput"}, "errors":[ - {"shape":"InvalidArn"} + {"shape":"InvalidArn"}, + {"shape":"ValidationException"} ] }, "DescribeActivity":{ @@ -100,6 +101,19 @@ {"shape":"InvalidArn"} ] }, + "DescribeMapRun":{ + "name":"DescribeMapRun", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeMapRunInput"}, + "output":{"shape":"DescribeMapRunOutput"}, + "errors":[ + {"shape":"ResourceNotFound"}, + {"shape":"InvalidArn"} + ] + }, "DescribeStateMachine":{ "name":"DescribeStateMachine", "http":{ @@ -178,7 +192,23 @@ {"shape":"InvalidArn"}, {"shape":"InvalidToken"}, {"shape":"StateMachineDoesNotExist"}, - {"shape":"StateMachineTypeNotSupported"} + {"shape":"StateMachineTypeNotSupported"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFound"} + ] + }, + "ListMapRuns":{ + "name":"ListMapRuns", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListMapRunsInput"}, + "output":{"shape":"ListMapRunsOutput"}, + "errors":[ + {"shape":"ExecutionDoesNotExist"}, + {"shape":"InvalidArn"}, + {"shape":"InvalidToken"} ] }, "ListStateMachines":{ @@ -264,7 +294,8 @@ {"shape":"InvalidExecutionInput"}, {"shape":"InvalidName"}, {"shape":"StateMachineDoesNotExist"}, - {"shape":"StateMachineDeleting"} + {"shape":"StateMachineDeleting"}, + {"shape":"ValidationException"} ], "idempotent":true }, @@ -296,7 +327,8 @@ "output":{"shape":"StopExecutionOutput"}, "errors":[ {"shape":"ExecutionDoesNotExist"}, - {"shape":"InvalidArn"} + {"shape":"InvalidArn"}, + {"shape":"ValidationException"} ] }, "TagResource":{ @@ -326,6 +358,20 @@ {"shape":"ResourceNotFound"} ] }, + "UpdateMapRun":{ + "name":"UpdateMapRun", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateMapRunInput"}, + "output":{"shape":"UpdateMapRunOutput"}, + "errors":[ + {"shape":"ResourceNotFound"}, + {"shape":"InvalidArn"}, + {"shape":"ValidationException"} + ] + }, "UpdateStateMachine":{ "name":"UpdateStateMachine", "http":{ @@ -341,7 +387,8 @@ {"shape":"InvalidTracingConfiguration"}, {"shape":"MissingRequiredParameter"}, {"shape":"StateMachineDeleting"}, - {"shape":"StateMachineDoesNotExist"} + {"shape":"StateMachineDoesNotExist"}, + {"shape":"ValidationException"} ], "idempotent":true } @@ -597,7 +644,43 @@ "inputDetails":{"shape":"CloudWatchEventsExecutionDataDetails"}, "output":{"shape":"SensitiveData"}, "outputDetails":{"shape":"CloudWatchEventsExecutionDataDetails"}, - "traceHeader":{"shape":"TraceHeader"} + "traceHeader":{"shape":"TraceHeader"}, + "mapRunArn":{"shape":"LongArn"}, + "error":{"shape":"SensitiveError"}, + "cause":{"shape":"SensitiveCause"} + } + }, + "DescribeMapRunInput":{ + "type":"structure", + "required":["mapRunArn"], + "members":{ + "mapRunArn":{"shape":"LongArn"} + } + }, + "DescribeMapRunOutput":{ + "type":"structure", + "required":[ + "mapRunArn", + "executionArn", + "status", + "startDate", + "maxConcurrency", + "toleratedFailurePercentage", + "toleratedFailureCount", + "itemCounts", + "executionCounts" + ], + "members":{ + "mapRunArn":{"shape":"LongArn"}, + "executionArn":{"shape":"Arn"}, + "status":{"shape":"MapRunStatus"}, + "startDate":{"shape":"Timestamp"}, + "stopDate":{"shape":"Timestamp"}, + "maxConcurrency":{"shape":"MaxConcurrency"}, + "toleratedFailurePercentage":{"shape":"ToleratedFailurePercentage"}, + "toleratedFailureCount":{"shape":"ToleratedFailureCount"}, + "itemCounts":{"shape":"MapRunItemCounts"}, + "executionCounts":{"shape":"MapRunExecutionCounts"} } }, "DescribeStateMachineForExecutionInput":{ @@ -623,7 +706,9 @@ "roleArn":{"shape":"Arn"}, "updateDate":{"shape":"Timestamp"}, "loggingConfiguration":{"shape":"LoggingConfiguration"}, - "tracingConfiguration":{"shape":"TracingConfiguration"} + "tracingConfiguration":{"shape":"TracingConfiguration"}, + "mapRunArn":{"shape":"LongArn"}, + "label":{"shape":"MapRunLabel"} } }, "DescribeStateMachineInput":{ @@ -652,7 +737,8 @@ "type":{"shape":"StateMachineType"}, "creationDate":{"shape":"Timestamp"}, "loggingConfiguration":{"shape":"LoggingConfiguration"}, - "tracingConfiguration":{"shape":"TracingConfiguration"} + "tracingConfiguration":{"shape":"TracingConfiguration"}, + "label":{"shape":"MapRunLabel"} } }, "Enabled":{"type":"boolean"}, @@ -712,7 +798,12 @@ "name":{"shape":"Name"}, "status":{"shape":"ExecutionStatus"}, "startDate":{"shape":"Timestamp"}, - "stopDate":{"shape":"Timestamp"} + "stopDate":{"shape":"Timestamp"}, + "mapRunArn":{"shape":"LongArn"}, + "itemCount":{ + "shape":"UnsignedInteger", + "box":true + } } }, "ExecutionStartedEventDetails":{ @@ -824,7 +915,9 @@ "lambdaFunctionSucceededEventDetails":{"shape":"LambdaFunctionSucceededEventDetails"}, "lambdaFunctionTimedOutEventDetails":{"shape":"LambdaFunctionTimedOutEventDetails"}, "stateEnteredEventDetails":{"shape":"StateEnteredEventDetails"}, - "stateExitedEventDetails":{"shape":"StateExitedEventDetails"} + "stateExitedEventDetails":{"shape":"StateExitedEventDetails"}, + "mapRunStartedEventDetails":{"shape":"MapRunStartedEventDetails"}, + "mapRunFailedEventDetails":{"shape":"MapRunFailedEventDetails"} } }, "HistoryEventExecutionDataDetails":{ @@ -894,7 +987,11 @@ "TaskTimedOut", "WaitStateAborted", "WaitStateEntered", - "WaitStateExited" + "WaitStateExited", + "MapRunAborted", + "MapRunFailed", + "MapRunStarted", + "MapRunSucceeded" ] }, "Identity":{ @@ -1028,12 +1125,12 @@ }, "ListExecutionsInput":{ "type":"structure", - "required":["stateMachineArn"], "members":{ "stateMachineArn":{"shape":"Arn"}, "statusFilter":{"shape":"ExecutionStatus"}, "maxResults":{"shape":"PageSize"}, - "nextToken":{"shape":"ListExecutionsPageToken"} + "nextToken":{"shape":"ListExecutionsPageToken"}, + "mapRunArn":{"shape":"LongArn"} } }, "ListExecutionsOutput":{ @@ -1049,6 +1146,23 @@ "max":3096, "min":1 }, + "ListMapRunsInput":{ + "type":"structure", + "required":["executionArn"], + "members":{ + "executionArn":{"shape":"Arn"}, + "maxResults":{"shape":"PageSize"}, + "nextToken":{"shape":"PageToken"} + } + }, + "ListMapRunsOutput":{ + "type":"structure", + "required":["mapRuns"], + "members":{ + "mapRuns":{"shape":"MapRunList"}, + "nextToken":{"shape":"PageToken"} + } + }, "ListStateMachinesInput":{ "type":"structure", "members":{ @@ -1106,7 +1220,7 @@ }, "LongArn":{ "type":"string", - "max":1600, + "max":2000, "min":1 }, "MapIterationEventDetails":{ @@ -1116,12 +1230,105 @@ "index":{"shape":"UnsignedInteger"} } }, + "MapRunExecutionCounts":{ + "type":"structure", + "required":[ + "pending", + "running", + "succeeded", + "failed", + "timedOut", + "aborted", + "total", + "resultsWritten" + ], + "members":{ + "pending":{"shape":"UnsignedLong"}, + "running":{"shape":"UnsignedLong"}, + "succeeded":{"shape":"UnsignedLong"}, + "failed":{"shape":"UnsignedLong"}, + "timedOut":{"shape":"UnsignedLong"}, + "aborted":{"shape":"UnsignedLong"}, + "total":{"shape":"UnsignedLong"}, + "resultsWritten":{"shape":"UnsignedLong"} + } + }, + "MapRunFailedEventDetails":{ + "type":"structure", + "members":{ + "error":{"shape":"SensitiveError"}, + "cause":{"shape":"SensitiveCause"} + } + }, + "MapRunItemCounts":{ + "type":"structure", + "required":[ + "pending", + "running", + "succeeded", + "failed", + "timedOut", + "aborted", + "total", + "resultsWritten" + ], + "members":{ + "pending":{"shape":"UnsignedLong"}, + "running":{"shape":"UnsignedLong"}, + "succeeded":{"shape":"UnsignedLong"}, + "failed":{"shape":"UnsignedLong"}, + "timedOut":{"shape":"UnsignedLong"}, + "aborted":{"shape":"UnsignedLong"}, + "total":{"shape":"UnsignedLong"}, + "resultsWritten":{"shape":"UnsignedLong"} + } + }, + "MapRunLabel":{"type":"string"}, + "MapRunList":{ + "type":"list", + "member":{"shape":"MapRunListItem"} + }, + "MapRunListItem":{ + "type":"structure", + "required":[ + "executionArn", + "mapRunArn", + "stateMachineArn", + "startDate" + ], + "members":{ + "executionArn":{"shape":"Arn"}, + "mapRunArn":{"shape":"LongArn"}, + "stateMachineArn":{"shape":"Arn"}, + "startDate":{"shape":"Timestamp"}, + "stopDate":{"shape":"Timestamp"} + } + }, + "MapRunStartedEventDetails":{ + "type":"structure", + "members":{ + "mapRunArn":{"shape":"LongArn"} + } + }, + "MapRunStatus":{ + "type":"string", + "enum":[ + "RUNNING", + "SUCCEEDED", + "FAILED", + "ABORTED" + ] + }, "MapStateStartedEventDetails":{ "type":"structure", "members":{ "length":{"shape":"UnsignedInteger"} } }, + "MaxConcurrency":{ + "type":"integer", + "min":0 + }, "MissingRequiredParameter":{ "type":"structure", "members":{ @@ -1564,6 +1771,15 @@ }, "TimeoutInSeconds":{"type":"long"}, "Timestamp":{"type":"timestamp"}, + "ToleratedFailureCount":{ + "type":"long", + "min":0 + }, + "ToleratedFailurePercentage":{ + "type":"float", + "max":100, + "min":0 + }, "TooManyTags":{ "type":"structure", "members":{ @@ -1588,6 +1804,10 @@ "type":"integer", "min":0 }, + "UnsignedLong":{ + "type":"long", + "min":0 + }, "UntagResourceInput":{ "type":"structure", "required":[ @@ -1604,6 +1824,30 @@ "members":{ } }, + "UpdateMapRunInput":{ + "type":"structure", + "required":["mapRunArn"], + "members":{ + "mapRunArn":{"shape":"LongArn"}, + "maxConcurrency":{ + "shape":"MaxConcurrency", + "box":true + }, + "toleratedFailurePercentage":{ + "shape":"ToleratedFailurePercentage", + "box":true + }, + "toleratedFailureCount":{ + "shape":"ToleratedFailureCount", + "box":true + } + } + }, + "UpdateMapRunOutput":{ + "type":"structure", + "members":{ + } + }, "UpdateStateMachineInput":{ "type":"structure", "required":["stateMachineArn"], @@ -1622,6 +1866,22 @@ "updateDate":{"shape":"Timestamp"} } }, + "ValidationException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"}, + "reason":{"shape":"ValidationExceptionReason"} + }, + "exception":true + }, + "ValidationExceptionReason":{ + "type":"string", + "enum":[ + "API_DOES_NOT_SUPPORT_LABELED_ARNS", + "MISSING_REQUIRED_PARAMETER", + "CANNOT_UPDATE_COMPLETED_MAP_RUN" + ] + }, "includedDetails":{"type":"boolean"}, "truncated":{"type":"boolean"} } diff --git a/models/apis/states/2016-11-23/docs-2.json b/models/apis/states/2016-11-23/docs-2.json index c55ef71745c..e9bab636df6 100644 --- a/models/apis/states/2016-11-23/docs-2.json +++ b/models/apis/states/2016-11-23/docs-2.json @@ -5,26 +5,29 @@ "CreateActivity": "Creates an activity. An activity is a task that you write in any programming language and host on any machine that has access to Step Functions. Activities must poll Step Functions using the GetActivityTask API action and respond using SendTask* API actions. This function lets Step Functions know the existence of your activity and returns an identifier for use in a state machine and when polling from the activity.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
CreateActivity is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateActivity's idempotency check is based on the activity name. If a following request has different tags values, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, tags will not be updated, even if they are different.
Creates a state machine. A state machine consists of a collection of states that can do work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are specified using a JSON-based, structured language. For more information, see Amazon States Language in the Step Functions User Guide.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
CreateStateMachine is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateStateMachine's idempotency check is based on the state machine name, definition, type, LoggingConfiguration and TracingConfiguration. If a following request has a different roleArn or tags, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, roleArn and tags will not be updated, even if they are different.
Deletes an activity.
", - "DeleteStateMachine": "Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to DELETING and begins the deletion process.
For EXPRESS state machines, the deletion will happen eventually (usually less than a minute). Running executions may emit logs after DeleteStateMachine API is called.
Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to DELETING and begins the deletion process.
If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException.
A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName.
For EXPRESS state machines, the deletion will happen eventually (usually less than a minute). Running executions may emit logs after DeleteStateMachine API is called.
Describes an activity.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
Describes an execution.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This API action is not supported by EXPRESS state machines.
Describes a state machine.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
Describes the state machine associated with a specific execution.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This API action is not supported by EXPRESS state machines.
Provides all information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata. Use this API action to return the Map Run ARN if the execution was dispatched by a Map Run.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This API action is not supported by EXPRESS state machine executions unless they were dispatched by a Map Run.
Provides information about a Map Run's configuration, progress, and results. For more information, see Examining Map Run in the Step Functions Developer Guide.
", + "DescribeStateMachine": "Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration. If the state machine ARN is a qualified state machine ARN, the response returned includes the Map state's label.
A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
Provides information about a state machine's definition, its execution role ARN, and configuration. If an execution was dispatched by a Map Run, the Map Run is returned in the response. Additionally, the state machine returned will be the state machine associated with the Map Run.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This API action is not supported by EXPRESS state machines.
Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll returns a taskToken with a null string.
This API action isn't logged in CloudTrail.
Workers should set their client side socket timeout to at least 65 seconds (5 seconds higher than the maximum time the service may hold the poll request).
Polling with GetActivityTask can cause latency in some implementations. See Avoid Latency When Polling for Activity Tasks in the Step Functions Developer Guide.
Returns the history of the specified execution as a list of events. By default, the results are returned in ascending order of the timeStamp of the events. Use the reverseOrder parameter to get the latest events first.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
This API action is not supported by EXPRESS state machines.
Lists the existing activities.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
Lists the executions of a state machine that meet the filtering criteria. Results are sorted by time, with the most recent execution first.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This API action is not supported by EXPRESS state machines.
Lists all executions of a state machine or a Map Run. You can list all executions related to a state machine by specifying a state machine Amazon Resource Name (ARN), or those related to a Map Run by specifying a Map Run ARN.
Results are sorted by time, with the most recent execution first.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This API action is not supported by EXPRESS state machines.
Lists all Map Runs that were started by a given state machine execution. Use this API action to obtain Map Run ARNs, and then call DescribeMapRun to obtain more information, if needed.
Lists the existing state machines.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
List tags for a given resource.
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken failed.
Used by activity workers and task states using the callback pattern to report to Step Functions that the task represented by the specified taskToken is still making progress. This action resets the Heartbeat clock. The Heartbeat threshold is specified in the state machine's Amazon States Language definition (HeartbeatSeconds). This action does not in itself create an event in the execution history. However, if the task times out, the execution history contains an ActivityTimedOut entry for activities, or a TaskTimedOut entry for for tasks using the job run or callback pattern.
The Timeout of a task, defined in the state machine's Amazon States Language definition, is its maximum allowed duration, regardless of the number of SendTaskHeartbeat requests received. Use HeartbeatSeconds to configure the timeout interval for heartbeats.
Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken completed successfully.
Starts a state machine execution.
StartExecution is idempotent for STANDARD workflows. For a STANDARD workflow, if StartExecution is called with the same name and input as a running execution, the call will succeed and return the same response as the original request. If the execution is closed or if the input is different, it will return a 400 ExecutionAlreadyExists error. Names can be reused after 90 days.
StartExecution is not idempotent for EXPRESS workflows.
Starts a state machine execution. If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException.
A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName.
StartExecution is idempotent for STANDARD workflows. For a STANDARD workflow, if StartExecution is called with the same name and input as a running execution, the call will succeed and return the same response as the original request. If the execution is closed or if the input is different, it will return a 400 ExecutionAlreadyExists error. Names can be reused after 90 days.
StartExecution is not idempotent for EXPRESS workflows.
Starts a Synchronous Express state machine execution. StartSyncExecution is not available for STANDARD workflows.
StartSyncExecution will return a 200 OK response, even if your execution fails, because the status code in the API response doesn't reflect function errors. Error codes are reserved for errors that prevent your execution from running, such as permissions errors, limit errors, or issues with your state machine code and configuration.
This API action isn't logged in CloudTrail.
Stops an execution.
This API action is not supported by EXPRESS state machines.
Add a tag to a Step Functions resource.
An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
Remove a tag from a Step Functions resource
", - "UpdateStateMachine": "Updates an existing state machine by modifying its definition, roleArn, or loggingConfiguration. Running executions will continue to use the previous definition and roleArn. You must include at least one of definition or roleArn or you will receive a MissingRequiredParameter error.
All StartExecution calls within a few seconds will use the updated definition and roleArn. Executions started immediately after calling UpdateStateMachine may use the previous state machine definition and roleArn.
Updates an in-progress Map Run's configuration to include changes to the settings that control maximum concurrency and Map Run failure.
", + "UpdateStateMachine": "Updates an existing state machine by modifying its definition, roleArn, or loggingConfiguration. Running executions will continue to use the previous definition and roleArn. You must include at least one of definition or roleArn or you will receive a MissingRequiredParameter error.
If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException.
A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName.
All StartExecution calls within a few seconds will use the updated definition and roleArn. Executions started immediately after calling UpdateStateMachine may use the previous state machine definition and roleArn.
The Amazon Resource Name (ARN) of the execution to describe.
", "DescribeExecutionOutput$executionArn": "The Amazon Resource Name (ARN) that identifies the execution.
", "DescribeExecutionOutput$stateMachineArn": "The Amazon Resource Name (ARN) of the executed stated machine.
", + "DescribeMapRunOutput$executionArn": "The Amazon Resource Name (ARN) that identifies the execution in which the Map Run was started.
", "DescribeStateMachineForExecutionInput$executionArn": "The Amazon Resource Name (ARN) of the execution you want state machine information for.
", "DescribeStateMachineForExecutionOutput$stateMachineArn": "The Amazon Resource Name (ARN) of the state machine associated with the execution.
", "DescribeStateMachineForExecutionOutput$roleArn": "The Amazon Resource Name (ARN) of the IAM role of the State Machine for the execution.
", @@ -118,8 +122,11 @@ "GetActivityTaskInput$activityArn": "The Amazon Resource Name (ARN) of the activity to retrieve tasks from (assigned when you create the task using CreateActivity.)
", "GetExecutionHistoryInput$executionArn": "The Amazon Resource Name (ARN) of the execution.
", "LambdaFunctionScheduledEventDetails$resource": "The Amazon Resource Name (ARN) of the scheduled Lambda function.
", - "ListExecutionsInput$stateMachineArn": "The Amazon Resource Name (ARN) of the state machine whose executions is listed.
", + "ListExecutionsInput$stateMachineArn": "The Amazon Resource Name (ARN) of the state machine whose executions is listed.
You can specify either a mapRunArn or a stateMachineArn, but not both.
The Amazon Resource Name (ARN) of the execution for which the Map Runs must be listed.
", "ListTagsForResourceInput$resourceArn": "The Amazon Resource Name (ARN) for the Step Functions state machine or activity.
", + "MapRunListItem$executionArn": "The executionArn of the execution from which the Map Run was started.
The Amazon Resource Name (ARN) of the executed state machine.
", "ResourceNotFound$resourceName": null, "StartExecutionInput$stateMachineArn": "The Amazon Resource Name (ARN) of the state machine to execute.
", "StartExecutionOutput$executionArn": "The Amazon Resource Name (ARN) that identifies the execution.
", @@ -243,6 +250,16 @@ "refs": { } }, + "DescribeMapRunInput": { + "base": null, + "refs": { + } + }, + "DescribeMapRunOutput": { + "base": null, + "refs": { + } + }, "DescribeStateMachineForExecutionInput": { "base": null, "refs": { @@ -295,7 +312,8 @@ "StateMachineTypeNotSupported$message": null, "TaskDoesNotExist$message": null, "TaskTimedOut$message": null, - "TooManyTags$message": null + "TooManyTags$message": null, + "ValidationException$message": null } }, "EventId": { @@ -442,17 +460,17 @@ } }, "InvalidArn": { - "base": "The provided Amazon Resource Name (ARN) is invalid.
", + "base": "The provided Amazon Resource Name (ARN) is not valid.
", "refs": { } }, "InvalidDefinition": { - "base": "The provided Amazon States Language definition is invalid.
", + "base": "The provided Amazon States Language definition is not valid.
", "refs": { } }, "InvalidExecutionInput": { - "base": "The provided JSON input data is invalid.
", + "base": "The provided JSON input data is not valid.
", "refs": { } }, @@ -462,17 +480,17 @@ } }, "InvalidName": { - "base": "The provided name is invalid.
", + "base": "The provided name is not valid.
", "refs": { } }, "InvalidOutput": { - "base": "The provided JSON output data is invalid.
", + "base": "The provided JSON output data is not valid.
", "refs": { } }, "InvalidToken": { - "base": "The provided token is invalid.
", + "base": "The provided token is not valid.
", "refs": { } }, @@ -544,6 +562,16 @@ "ListExecutionsOutput$nextToken": "If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
The ARN of an IAM role that Step Functions assumes for the task. The role can allow cross-account access to resources.
" + "DescribeExecutionOutput$mapRunArn": "The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution.
", + "DescribeMapRunInput$mapRunArn": "The Amazon Resource Name (ARN) that identifies a Map Run.
", + "DescribeMapRunOutput$mapRunArn": "The Amazon Resource Name (ARN) that identifies a Map Run.
", + "DescribeStateMachineForExecutionOutput$mapRunArn": "The Amazon Resource Name (ARN) of the Map Run that started the child workflow execution. This field is returned only if the executionArn is a child workflow execution that was started by a Distributed Map state.
The Amazon Resource Name (ARN) of a Map Run. This field is returned only if mapRunArn was specified in the ListExecutions API action. If stateMachineArn was specified in ListExecutions, the mapRunArn isn't returned.
The Amazon Resource Name (ARN) of the Map Run that started the child workflow executions. If the mapRunArn field is specified, a list of all of the child workflow executions started by a Map Run is returned. For more information, see Examining Map Run in the Step Functions Developer Guide.
You can specify either a mapRunArn or a stateMachineArn, but not both.
The Amazon Resource Name (ARN) of the Map Run.
", + "MapRunStartedEventDetails$mapRunArn": "The Amazon Resource Name (ARN) of a Map Run that was started.
", + "TaskCredentials$roleArn": "The ARN of an IAM role that Step Functions assumes for the task. The role can allow cross-account access to resources.
", + "UpdateMapRunInput$mapRunArn": "The Amazon Resource Name (ARN) of a Map Run.
" } }, "MapIterationEventDetails": { @@ -606,12 +643,68 @@ "HistoryEvent$mapIterationAbortedEventDetails": "Contains details about an iteration of a Map state that was aborted.
" } }, + "MapRunExecutionCounts": { + "base": "Contains details about all of the child workflow executions started by a Map Run.
", + "refs": { + "DescribeMapRunOutput$executionCounts": "A JSON object that contains information about the total number of child workflow executions for the Map Run, and the count of child workflow executions for each status, such as failed and succeeded.
Contains details about a Map Run failure event that occurred during a state machine execution.
", + "refs": { + "HistoryEvent$mapRunFailedEventDetails": "Contains error and cause details about a Map Run that failed.
" + } + }, + "MapRunItemCounts": { + "base": "Contains details about items that were processed in all of the child workflow executions that were started by a Map Run.
", + "refs": { + "DescribeMapRunOutput$itemCounts": "A JSON object that contains information about the total number of items, and the item count for each processing status, such as pending and failed.
A user-defined or an auto-generated string that identifies a Map state. This field is returned only if the executionArn is a child workflow execution that was started by a Distributed Map state.
A user-defined or an auto-generated string that identifies a Map state. This parameter is present only if the stateMachineArn specified in input is a qualified state machine ARN.
An array that lists information related to a Map Run, such as the Amazon Resource Name (ARN) of the Map Run and the ARN of the state machine that started the Map Run.
" + } + }, + "MapRunListItem": { + "base": "Contains details about a specific Map Run.
", + "refs": { + "MapRunList$member": null + } + }, + "MapRunStartedEventDetails": { + "base": "Contains details about a Map Run that was started during a state machine execution.
", + "refs": { + "HistoryEvent$mapRunStartedEventDetails": "Contains details, such as mapRunArn, and the start date and time of a Map Run. mapRunArn is the Amazon Resource Name (ARN) of the Map Run that was started.
The current status of the Map Run.
" + } + }, "MapStateStartedEventDetails": { "base": "Details about a Map state that was started.
", "refs": { "HistoryEvent$mapStateStartedEventDetails": "Contains details about Map state that was started.
" } }, + "MaxConcurrency": { + "base": null, + "refs": { + "DescribeMapRunOutput$maxConcurrency": "The maximum number of child workflow executions configured to run in parallel for the Map Run at the same time.
", + "UpdateMapRunInput$maxConcurrency": "The maximum number of child workflow executions that can be specified to run in parallel for the Map Run at the same time.
" + } + }, "MissingRequiredParameter": { "base": "Request is missing a required parameter. This error occurs if both definition and roleArn are not specified.
The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
", "ListActivitiesInput$maxResults": "The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
", "ListExecutionsInput$maxResults": "The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
", + "ListMapRunsInput$maxResults": "The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
", "ListStateMachinesInput$maxResults": "The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
" } }, @@ -671,6 +765,8 @@ "GetExecutionHistoryOutput$nextToken": "If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
A more detailed explanation of the cause of the failure.
", "ActivityScheduleFailedEventDetails$cause": "A more detailed explanation of the cause of the failure.
", "ActivityTimedOutEventDetails$cause": "A more detailed explanation of the cause of the timeout.
", + "DescribeExecutionOutput$cause": "The cause string if the state machine execution failed.
", "ExecutionAbortedEventDetails$cause": "A more detailed explanation of the cause of the failure.
", "ExecutionFailedEventDetails$cause": "A more detailed explanation of the cause of the failure.
", "ExecutionTimedOutEventDetails$cause": "A more detailed explanation of the cause of the timeout.
", @@ -729,6 +826,7 @@ "LambdaFunctionScheduleFailedEventDetails$cause": "A more detailed explanation of the cause of the failure.
", "LambdaFunctionStartFailedEventDetails$cause": "A more detailed explanation of the cause of the failure.
", "LambdaFunctionTimedOutEventDetails$cause": "A more detailed explanation of the cause of the timeout.
", + "MapRunFailedEventDetails$cause": "A more detailed explanation of the cause of the failure.
", "SendTaskFailureInput$cause": "A more detailed explanation of the cause of the failure.
", "StartSyncExecutionOutput$cause": "A more detailed explanation of the cause of the failure.
", "StopExecutionInput$cause": "A more detailed explanation of the cause of the failure.
", @@ -772,6 +870,7 @@ "ActivityFailedEventDetails$error": "The error code of the failure.
", "ActivityScheduleFailedEventDetails$error": "The error code of the failure.
", "ActivityTimedOutEventDetails$error": "The error code of the failure.
", + "DescribeExecutionOutput$error": "The error string if the state machine execution failed.
", "ExecutionAbortedEventDetails$error": "The error code of the failure.
", "ExecutionFailedEventDetails$error": "The error code of the failure.
", "ExecutionTimedOutEventDetails$error": "The error code of the failure.
", @@ -779,6 +878,7 @@ "LambdaFunctionScheduleFailedEventDetails$error": "The error code of the failure.
", "LambdaFunctionStartFailedEventDetails$error": "The error code of the failure.
", "LambdaFunctionTimedOutEventDetails$error": "The error code of the failure.
", + "MapRunFailedEventDetails$error": "The error code of the Map Run failure.
", "SendTaskFailureInput$error": "The error code of the failure.
", "StartSyncExecutionOutput$error": "The error code of the failure.
", "StopExecutionInput$error": "The error code of the failure.
", @@ -1024,11 +1124,15 @@ "DescribeActivityOutput$creationDate": "The date the activity is created.
", "DescribeExecutionOutput$startDate": "The date the execution is started.
", "DescribeExecutionOutput$stopDate": "If the execution has already ended, the date the execution stopped.
", + "DescribeMapRunOutput$startDate": "The date when the Map Run was started.
", + "DescribeMapRunOutput$stopDate": "The date when the Map Run was stopped.
", "DescribeStateMachineForExecutionOutput$updateDate": "The date and time the state machine associated with an execution was updated. For a newly created state machine, this is the creation date.
", "DescribeStateMachineOutput$creationDate": "The date the state machine is created.
", "ExecutionListItem$startDate": "The date the execution started.
", "ExecutionListItem$stopDate": "If the execution already ended, the date the execution stopped.
", "HistoryEvent$timestamp": "The date and time the event occurred.
", + "MapRunListItem$startDate": "The date on which the Map Run started.
", + "MapRunListItem$stopDate": "The date on which the Map Run stopped.
", "StartExecutionOutput$startDate": "The date the execution is started.
", "StartSyncExecutionOutput$startDate": "The date the execution is started.
", "StartSyncExecutionOutput$stopDate": "If the execution has already ended, the date the execution stopped.
", @@ -1037,6 +1141,20 @@ "UpdateStateMachineOutput$updateDate": "The date and time the state machine was updated.
" } }, + "ToleratedFailureCount": { + "base": null, + "refs": { + "DescribeMapRunOutput$toleratedFailureCount": "The maximum number of failed child workflow executions before the Map Run fails.
", + "UpdateMapRunInput$toleratedFailureCount": "The maximum number of failed items before the Map Run fails.
" + } + }, + "ToleratedFailurePercentage": { + "base": null, + "refs": { + "DescribeMapRunOutput$toleratedFailurePercentage": "The maximum percentage of failed child workflow executions before the Map Run fails.
", + "UpdateMapRunInput$toleratedFailurePercentage": "The maximum percentage of failed items before the Map Run fails.
" + } + }, "TooManyTags": { "base": "You've exceeded the number of tags allowed for a resource. See the Limits Topic in the Step Functions Developer Guide.
", "refs": { @@ -1063,10 +1181,32 @@ "UnsignedInteger": { "base": null, "refs": { + "ExecutionListItem$itemCount": "The total number of items processed in a child workflow execution. This field is returned only if mapRunArn was specified in the ListExecutions API action. If stateMachineArn was specified in ListExecutions, the itemCount field isn't returned.
The index of the array belonging to the Map state iteration.
", "MapStateStartedEventDetails$length": "The size of the array for Map state iterations.
" } }, + "UnsignedLong": { + "base": null, + "refs": { + "MapRunExecutionCounts$pending": "The total number of child workflow executions that were started by a Map Run, but haven't started executing yet.
", + "MapRunExecutionCounts$running": "The total number of child workflow executions that were started by a Map Run and are currently in-progress.
", + "MapRunExecutionCounts$succeeded": "The total number of child workflow executions that were started by a Map Run and have completed successfully.
", + "MapRunExecutionCounts$failed": "The total number of child workflow executions that were started by a Map Run, but have failed.
", + "MapRunExecutionCounts$timedOut": "The total number of child workflow executions that were started by a Map Run and have timed out.
", + "MapRunExecutionCounts$aborted": "The total number of child workflow executions that were started by a Map Run and were running, but were either stopped by the user or by Step Functions because the Map Run failed.
", + "MapRunExecutionCounts$total": "The total number of child workflow executions that were started by a Map Run.
", + "MapRunExecutionCounts$resultsWritten": "Returns the count of child workflow executions whose results were written by ResultWriter. For more information, see ResultWriter in the Step Functions Developer Guide.
The total number of items to process in child workflow executions that haven't started running yet.
", + "MapRunItemCounts$running": "The total number of items being processed in child workflow executions that are currently in-progress.
", + "MapRunItemCounts$succeeded": "The total number of items processed in child workflow executions that have completed successfully.
", + "MapRunItemCounts$failed": "The total number of items processed in child workflow executions that have failed.
", + "MapRunItemCounts$timedOut": "The total number of items processed in child workflow executions that have timed out.
", + "MapRunItemCounts$aborted": "The total number of items processed in child workflow executions that were either stopped by the user or by Step Functions, because the Map Run failed.
", + "MapRunItemCounts$total": "The total number of items processed in all the child workflow executions started by a Map Run.
", + "MapRunItemCounts$resultsWritten": "Returns the count of items whose results were written by ResultWriter. For more information, see ResultWriter in the Step Functions Developer Guide.
The input does not satisfy the constraints specified by an Amazon Web Services service.
", + "refs": { + } + }, + "ValidationExceptionReason": { + "base": null, + "refs": { + "ValidationException$reason": "The input does not satisfy the constraints specified by an Amazon Web Services service.
" + } + }, "includedDetails": { "base": null, "refs": { diff --git a/models/apis/states/2016-11-23/endpoint-rule-set-1.json b/models/apis/states/2016-11-23/endpoint-rule-set-1.json index 2568293487b..59fd81e898d 100644 --- a/models/apis/states/2016-11-23/endpoint-rule-set-1.json +++ b/models/apis/states/2016-11-23/endpoint-rule-set-1.json @@ -3,7 +3,7 @@ "parameters": { "Region": { "builtIn": "AWS::Region", - "required": false, + "required": true, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, diff --git a/models/apis/states/2016-11-23/paginators-1.json b/models/apis/states/2016-11-23/paginators-1.json index d7f05804c41..7f5a6db224b 100644 --- a/models/apis/states/2016-11-23/paginators-1.json +++ b/models/apis/states/2016-11-23/paginators-1.json @@ -18,6 +18,12 @@ "output_token": "nextToken", "result_key": "executions" }, + "ListMapRuns": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "mapRuns" + }, "ListStateMachines": { "input_token": "nextToken", "limit_key": "maxResults", diff --git a/models/endpoints/endpoints.json b/models/endpoints/endpoints.json index 81c600bfab6..00b272bf339 100644 --- a/models/endpoints/endpoints.json +++ b/models/endpoints/endpoints.json @@ -2734,6 +2734,15 @@ } } }, + "codecatalyst" : { + "endpoints" : { + "aws-global" : { + "hostname" : "codecatalyst.global.api.aws" + } + }, + "isRegionalized" : false, + "partitionEndpoint" : "aws-global" + }, "codecommit" : { "endpoints" : { "af-south-1" : { }, @@ -10558,6 +10567,33 @@ } } }, + "pipes" : { + "endpoints" : { + "af-south-1" : { }, + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-northeast-3" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ap-southeast-3" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-south-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-central-1" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, "polly" : { "endpoints" : { "af-south-1" : { }, diff --git a/service/comprehend/api.go b/service/comprehend/api.go index 5b759bb2c56..6958d513192 100644 --- a/service/comprehend/api.go +++ b/service/comprehend/api.go @@ -641,6 +641,17 @@ func (c *Comprehend) ClassifyDocumentRequest(input *ClassifyDocumentInput) (req // in real-time, using a previously created and trained custom model and an // endpoint. // +// You can input plain text or you can upload a single-page input document (text, +// PDF, Word, or image). +// +// If the system detects errors while processing a page in the input document, +// the API response includes an entry in Errors that describes the errors. +// +// If the system detects a document-level error in your input document, the +// API returns an InvalidRequestException error response. For details about +// this exception, see Errors in semi-structured documents (https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync-err.html) +// in the Comprehend Developer Guide. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -2793,8 +2804,22 @@ func (c *Comprehend) DetectEntitiesRequest(input *DetectEntitiesInput) (req *req // DetectEntities API operation for Amazon Comprehend. // -// Inspects text for named entities, and returns information about them. For -// more information, about named entities, see Entities (https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html) +// Detects named entities in input text when you use the pre-trained model. +// Detects custom entities if you have a custom entity recognition model. +// +// When detecting named entities using the pre-trained model, use plain text +// as the input. For more information about named entities, see Entities (https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html) +// in the Comprehend Developer Guide. +// +// When you use a custom entity recognition model, you can input plain text +// or you can upload a single-page input document (text, PDF, Word, or image). +// +// If the system detects errors while processing a page in the input document, +// the API response includes an entry in Errors for each error. +// +// If the system detects a document-level error in your input document, the +// API returns an InvalidRequestException error response. For details about +// this exception, see Errors in semi-structured documents (https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync-err.html) // in the Comprehend Developer Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -4039,6 +4064,12 @@ func (c *Comprehend) ListEndpointsRequest(input *ListEndpointsInput) (req *reque Name: opListEndpoints, HTTPMethod: "POST", HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, } if input == nil { @@ -4095,6 +4126,57 @@ func (c *Comprehend) ListEndpointsWithContext(ctx aws.Context, input *ListEndpoi return out, req.Send() } +// ListEndpointsPages iterates over the pages of a ListEndpoints operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListEndpoints method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListEndpoints operation. +// pageNum := 0 +// err := client.ListEndpointsPages(params, +// func(page *comprehend.ListEndpointsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +func (c *Comprehend) ListEndpointsPages(input *ListEndpointsInput, fn func(*ListEndpointsOutput, bool) bool) error { + return c.ListEndpointsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListEndpointsPagesWithContext same as ListEndpointsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Comprehend) ListEndpointsPagesWithContext(ctx aws.Context, input *ListEndpointsInput, fn func(*ListEndpointsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListEndpointsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListEndpointsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListEndpointsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opListEntitiesDetectionJobs = "ListEntitiesDetectionJobs" // ListEntitiesDetectionJobsRequest generates a "aws/request.Request" representing the @@ -4854,6 +4936,12 @@ func (c *Comprehend) ListPiiEntitiesDetectionJobsRequest(input *ListPiiEntitiesD Name: opListPiiEntitiesDetectionJobs, HTTPMethod: "POST", HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, } if input == nil { @@ -4912,6 +5000,57 @@ func (c *Comprehend) ListPiiEntitiesDetectionJobsWithContext(ctx aws.Context, in return out, req.Send() } +// ListPiiEntitiesDetectionJobsPages iterates over the pages of a ListPiiEntitiesDetectionJobs operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListPiiEntitiesDetectionJobs method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListPiiEntitiesDetectionJobs operation. +// pageNum := 0 +// err := client.ListPiiEntitiesDetectionJobsPages(params, +// func(page *comprehend.ListPiiEntitiesDetectionJobsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +func (c *Comprehend) ListPiiEntitiesDetectionJobsPages(input *ListPiiEntitiesDetectionJobsInput, fn func(*ListPiiEntitiesDetectionJobsOutput, bool) bool) error { + return c.ListPiiEntitiesDetectionJobsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListPiiEntitiesDetectionJobsPagesWithContext same as ListPiiEntitiesDetectionJobsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Comprehend) ListPiiEntitiesDetectionJobsPagesWithContext(ctx aws.Context, input *ListPiiEntitiesDetectionJobsInput, fn func(*ListPiiEntitiesDetectionJobsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListPiiEntitiesDetectionJobsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListPiiEntitiesDetectionJobsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListPiiEntitiesDetectionJobsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opListSentimentDetectionJobs = "ListSentimentDetectionJobs" // ListSentimentDetectionJobsRequest generates a "aws/request.Request" representing the @@ -8746,6 +8885,269 @@ func (s *BatchSizeLimitExceededException) RequestID() string { return s.RespMetadata.RequestID } +// Information about each word or line of text in the input document. +// +// For additional information, see Block (https://docs.aws.amazon.com/textract/latest/dg/API_Block.html) +// in the Amazon Textract API reference. +type Block struct { + _ struct{} `type:"structure"` + + // The block represents a line of text or one word of text. + // + // * WORD - A word that's detected on a document page. A word is one or more + // ISO basic Latin script characters that aren't separated by spaces. + // + // * LINE - A string of tab-delimited, contiguous words that are detected + // on a document page + BlockType *string `type:"string" enum:"BlockType"` + + // Co-ordinates of the rectangle or polygon that contains the text. + Geometry *Geometry `type:"structure"` + + // Unique identifier for the block. + Id *string `min:"1" type:"string"` + + // Page number where the block appears. + Page *int64 `type:"integer"` + + // A list of child blocks of the current block. For example, a LINE object has + // child blocks for each WORD block that's part of the line of text. + Relationships []*RelationshipsListItem `type:"list"` + + // The word or line of text extracted from the block. + Text *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Block) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Block) GoString() string { + return s.String() +} + +// SetBlockType sets the BlockType field's value. +func (s *Block) SetBlockType(v string) *Block { + s.BlockType = &v + return s +} + +// SetGeometry sets the Geometry field's value. +func (s *Block) SetGeometry(v *Geometry) *Block { + s.Geometry = v + return s +} + +// SetId sets the Id field's value. +func (s *Block) SetId(v string) *Block { + s.Id = &v + return s +} + +// SetPage sets the Page field's value. +func (s *Block) SetPage(v int64) *Block { + s.Page = &v + return s +} + +// SetRelationships sets the Relationships field's value. +func (s *Block) SetRelationships(v []*RelationshipsListItem) *Block { + s.Relationships = v + return s +} + +// SetText sets the Text field's value. +func (s *Block) SetText(v string) *Block { + s.Text = &v + return s +} + +// A reference to a block. +type BlockReference struct { + _ struct{} `type:"structure"` + + // Offset of the start of the block within its parent block. + BeginOffset *int64 `type:"integer"` + + // Unique identifier for the block. + BlockId *string `min:"1" type:"string"` + + // List of child blocks within this block. + ChildBlocks []*ChildBlock `type:"list"` + + // Offset of the end of the block within its parent block. + EndOffset *int64 `type:"integer"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s BlockReference) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s BlockReference) GoString() string { + return s.String() +} + +// SetBeginOffset sets the BeginOffset field's value. +func (s *BlockReference) SetBeginOffset(v int64) *BlockReference { + s.BeginOffset = &v + return s +} + +// SetBlockId sets the BlockId field's value. +func (s *BlockReference) SetBlockId(v string) *BlockReference { + s.BlockId = &v + return s +} + +// SetChildBlocks sets the ChildBlocks field's value. +func (s *BlockReference) SetChildBlocks(v []*ChildBlock) *BlockReference { + s.ChildBlocks = v + return s +} + +// SetEndOffset sets the EndOffset field's value. +func (s *BlockReference) SetEndOffset(v int64) *BlockReference { + s.EndOffset = &v + return s +} + +// The bounding box around the detected page or around an element on a document +// page. The left (x-coordinate) and top (y-coordinate) are coordinates that +// represent the top and left sides of the bounding box. Note that the upper-left +// corner of the image is the origin (0,0). +// +// For additional information, see BoundingBox (https://docs.aws.amazon.com/textract/latest/dg/API_BoundingBox.html) +// in the Amazon Textract API reference. +type BoundingBox struct { + _ struct{} `type:"structure"` + + // The height of the bounding box as a ratio of the overall document page height. + Height *float64 `type:"float"` + + // The left coordinate of the bounding box as a ratio of overall document page + // width. + Left *float64 `type:"float"` + + // The top coordinate of the bounding box as a ratio of overall document page + // height. + Top *float64 `type:"float"` + + // The width of the bounding box as a ratio of the overall document page width. + Width *float64 `type:"float"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s BoundingBox) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s BoundingBox) GoString() string { + return s.String() +} + +// SetHeight sets the Height field's value. +func (s *BoundingBox) SetHeight(v float64) *BoundingBox { + s.Height = &v + return s +} + +// SetLeft sets the Left field's value. +func (s *BoundingBox) SetLeft(v float64) *BoundingBox { + s.Left = &v + return s +} + +// SetTop sets the Top field's value. +func (s *BoundingBox) SetTop(v float64) *BoundingBox { + s.Top = &v + return s +} + +// SetWidth sets the Width field's value. +func (s *BoundingBox) SetWidth(v float64) *BoundingBox { + s.Width = &v + return s +} + +// Nested block contained within a block. +type ChildBlock struct { + _ struct{} `type:"structure"` + + // Offset of the start of the child block within its parent block. + BeginOffset *int64 `type:"integer"` + + // Unique identifier for the child block. + ChildBlockId *string `min:"1" type:"string"` + + // Offset of the end of the child block within its parent block. + EndOffset *int64 `type:"integer"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ChildBlock) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ChildBlock) GoString() string { + return s.String() +} + +// SetBeginOffset sets the BeginOffset field's value. +func (s *ChildBlock) SetBeginOffset(v int64) *ChildBlock { + s.BeginOffset = &v + return s +} + +// SetChildBlockId sets the ChildBlockId field's value. +func (s *ChildBlock) SetChildBlockId(v string) *ChildBlock { + s.ChildBlockId = &v + return s +} + +// SetEndOffset sets the EndOffset field's value. +func (s *ChildBlock) SetEndOffset(v int64) *ChildBlock { + s.EndOffset = &v + return s +} + // Describes the result metrics for the test data associated with an documentation // classifier. type ClassifierEvaluationMetrics struct { @@ -8929,20 +9331,39 @@ func (s *ClassifierMetadata) SetNumberOfTrainedDocuments(v int64) *ClassifierMet type ClassifyDocumentInput struct { _ struct{} `type:"structure"` + // Use the Bytes parameter to input a text, PDF, Word or image file. You can + // also use the Bytes parameter to input an Amazon Textract DetectDocumentText + // or AnalyzeDocument output file. + // + // Provide the input document as a sequence of base64-encoded bytes. If your + // code uses an Amazon Web Services SDK to classify documents, the SDK may encode + // the document file bytes for you. + // + // The maximum length of this field depends on the input document type. For + // details, see Inputs for real-time custom analysis (https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync.html) + // in the Comprehend Developer Guide. + // + // If you use the Bytes parameter, do not use the Text parameter. + // Bytes is automatically base64 encoded/decoded by the SDK. + Bytes []byte `min:"1" type:"blob"` + + // Provides configuration parameters to override the default actions for extracting + // text from PDF documents and image files. + DocumentReaderConfig *DocumentReaderConfig `type:"structure"` + // The Amazon Resource Number (ARN) of the endpoint. For information about endpoints, // see Managing endpoints (https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html). // // EndpointArn is a required field EndpointArn *string `type:"string" required:"true"` - // The document text to be analyzed. + // The document text to be analyzed. If you enter text using this parameter, + // do not use the Bytes parameter. // // Text is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by ClassifyDocumentInput's // String and GoString methods. - // - // Text is a required field - Text *string `min:"1" type:"string" required:"true" sensitive:"true"` + Text *string `min:"1" type:"string" sensitive:"true"` } // String returns the string representation. @@ -8966,15 +9387,20 @@ func (s ClassifyDocumentInput) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *ClassifyDocumentInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "ClassifyDocumentInput"} + if s.Bytes != nil && len(s.Bytes) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Bytes", 1)) + } if s.EndpointArn == nil { invalidParams.Add(request.NewErrParamRequired("EndpointArn")) } - if s.Text == nil { - invalidParams.Add(request.NewErrParamRequired("Text")) - } if s.Text != nil && len(*s.Text) < 1 { invalidParams.Add(request.NewErrParamMinLen("Text", 1)) } + if s.DocumentReaderConfig != nil { + if err := s.DocumentReaderConfig.Validate(); err != nil { + invalidParams.AddNested("DocumentReaderConfig", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -8982,6 +9408,18 @@ func (s *ClassifyDocumentInput) Validate() error { return nil } +// SetBytes sets the Bytes field's value. +func (s *ClassifyDocumentInput) SetBytes(v []byte) *ClassifyDocumentInput { + s.Bytes = v + return s +} + +// SetDocumentReaderConfig sets the DocumentReaderConfig field's value. +func (s *ClassifyDocumentInput) SetDocumentReaderConfig(v *DocumentReaderConfig) *ClassifyDocumentInput { + s.DocumentReaderConfig = v + return s +} + // SetEndpointArn sets the EndpointArn field's value. func (s *ClassifyDocumentInput) SetEndpointArn(v string) *ClassifyDocumentInput { s.EndpointArn = &v @@ -9003,6 +9441,18 @@ type ClassifyDocumentOutput struct { // can be a dog or a cat, but not both at the same time. Classes []*DocumentClass `type:"list"` + // Extraction information about the document. This field is present in the response + // only if your request includes the Byte parameter. + DocumentMetadata *DocumentMetadata `type:"structure"` + + // The document type for each page in the input document. This field is present + // in the response only if your request includes the Byte parameter. + DocumentType []*DocumentTypeListItem `type:"list"` + + // Page-level errors that the system detected while processing the input document. + // The field is empty if the system encountered no errors. + Errors []*ErrorsListItem `type:"list"` + // The labels used the document being analyzed. These are used for multi-label // trained models. Individual labels represent different categories that are // related in some manner and are not mutually exclusive. For example, a movie @@ -9035,6 +9485,24 @@ func (s *ClassifyDocumentOutput) SetClasses(v []*DocumentClass) *ClassifyDocumen return s } +// SetDocumentMetadata sets the DocumentMetadata field's value. +func (s *ClassifyDocumentOutput) SetDocumentMetadata(v *DocumentMetadata) *ClassifyDocumentOutput { + s.DocumentMetadata = v + return s +} + +// SetDocumentType sets the DocumentType field's value. +func (s *ClassifyDocumentOutput) SetDocumentType(v []*DocumentTypeListItem) *ClassifyDocumentOutput { + s.DocumentType = v + return s +} + +// SetErrors sets the Errors field's value. +func (s *ClassifyDocumentOutput) SetErrors(v []*ErrorsListItem) *ClassifyDocumentOutput { + s.Errors = v + return s +} + // SetLabels sets the Labels field's value. func (s *ClassifyDocumentOutput) SetLabels(v []*DocumentLabel) *ClassifyDocumentOutput { s.Labels = v @@ -9657,9 +10125,11 @@ type CreateEntityRecognizerInput struct { // InputDataConfig is a required field InputDataConfig *EntityRecognizerInputDataConfig `type:"structure" required:"true"` - // You can specify any of the following languages supported by Amazon Comprehend: - // English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), - // or Portuguese ("pt"). All documents must be in the same language. + // You can specify any of the following languages: English ("en"), Spanish ("es"), + // French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). If you + // plan to use this entity recognizer with PDF, Word, or image input files, + // you must specify English as the language. All training documents must be + // in the same language. // // LanguageCode is a required field LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` @@ -10898,7 +11368,8 @@ func (s *DescribePiiEntitiesDetectionJobOutput) SetPiiEntitiesDetectionJobProper type DescribeResourcePolicyInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the policy to describe. + // The Amazon Resource Name (ARN) of the custom model version that has the resource + // policy. // // ResourceArn is a required field ResourceArn *string `type:"string" required:"true"` @@ -11336,6 +11807,33 @@ func (s *DetectDominantLanguageOutput) SetLanguages(v []*DominantLanguage) *Dete type DetectEntitiesInput struct { _ struct{} `type:"structure"` + // This field applies only when you use a custom entity recognition model that + // was trained with PDF annotations. For other cases, enter your text input + // in the Text field. + // + // Use the Bytes parameter to input a text, PDF, Word or image file. Using a + // plain-text file in the Bytes parameter is equivelent to using the Text parameter + // (the Entities field in the response is identical). + // + // You can also use the Bytes parameter to input an Amazon Textract DetectDocumentText + // or AnalyzeDocument output file. + // + // Provide the input document as a sequence of base64-encoded bytes. If your + // code uses an Amazon Web Services SDK to detect entities, the SDK may encode + // the document file bytes for you. + // + // The maximum length of this field depends on the input document type. For + // details, see Inputs for real-time custom analysis (https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync.html) + // in the Comprehend Developer Guide. + // + // If you use the Bytes parameter, do not use the Text parameter. + // Bytes is automatically base64 encoded/decoded by the SDK. + Bytes []byte `min:"1" type:"blob"` + + // Provides configuration parameters to override the default actions for extracting + // text from PDF documents and image files. + DocumentReaderConfig *DocumentReaderConfig `type:"structure"` + // The Amazon Resource Name of an endpoint that is associated with a custom // entity recognition model. Provide an endpoint if you want to detect entities // by using your own custom model instead of the default model that is used @@ -11348,21 +11846,20 @@ type DetectEntitiesInput struct { EndpointArn *string `type:"string"` // The language of the input documents. You can specify any of the primary languages - // supported by Amazon Comprehend. All documents must be in the same language. + // supported by Amazon Comprehend. If your request includes the endpoint for + // a custom entity recognition model, Amazon Comprehend uses the language of + // your custom model, and it ignores any language code that you specify here. // - // If your request includes the endpoint for a custom entity recognition model, - // Amazon Comprehend uses the language of your custom model, and it ignores - // any language code that you specify here. + // All input documents must be in the same language. LanguageCode *string `type:"string" enum:"LanguageCode"` - // A UTF-8 text string. The maximum string size is 100 KB. + // A UTF-8 text string. The maximum string size is 100 KB. If you enter text + // using this parameter, do not use the Bytes parameter. // // Text is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by DetectEntitiesInput's // String and GoString methods. - // - // Text is a required field - Text *string `min:"1" type:"string" required:"true" sensitive:"true"` + Text *string `min:"1" type:"string" sensitive:"true"` } // String returns the string representation. @@ -11386,12 +11883,17 @@ func (s DetectEntitiesInput) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *DetectEntitiesInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "DetectEntitiesInput"} - if s.Text == nil { - invalidParams.Add(request.NewErrParamRequired("Text")) + if s.Bytes != nil && len(s.Bytes) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Bytes", 1)) } if s.Text != nil && len(*s.Text) < 1 { invalidParams.Add(request.NewErrParamMinLen("Text", 1)) } + if s.DocumentReaderConfig != nil { + if err := s.DocumentReaderConfig.Validate(); err != nil { + invalidParams.AddNested("DocumentReaderConfig", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -11399,6 +11901,18 @@ func (s *DetectEntitiesInput) Validate() error { return nil } +// SetBytes sets the Bytes field's value. +func (s *DetectEntitiesInput) SetBytes(v []byte) *DetectEntitiesInput { + s.Bytes = v + return s +} + +// SetDocumentReaderConfig sets the DocumentReaderConfig field's value. +func (s *DetectEntitiesInput) SetDocumentReaderConfig(v *DocumentReaderConfig) *DetectEntitiesInput { + s.DocumentReaderConfig = v + return s +} + // SetEndpointArn sets the EndpointArn field's value. func (s *DetectEntitiesInput) SetEndpointArn(v string) *DetectEntitiesInput { s.EndpointArn = &v @@ -11420,6 +11934,23 @@ func (s *DetectEntitiesInput) SetText(v string) *DetectEntitiesInput { type DetectEntitiesOutput struct { _ struct{} `type:"structure" sensitive:"true"` + // Information about each block of text in the input document. Blocks are nested. + // A page block contains a block for each line of text, which contains a block + // for each word. + // + // The Block content for a Word input document does not include a Geometry field. + // + // The Block field is not present in the response for plain-text inputs. + Blocks []*Block `type:"list"` + + // Information about the document, discovered during text extraction. This field + // is present in the response only if your request used the Byte parameter. + DocumentMetadata *DocumentMetadata `type:"structure"` + + // The document type for each page in the input document. This field is present + // in the response only if your request used the Byte parameter. + DocumentType []*DocumentTypeListItem `type:"list"` + // A collection of entities identified in the input text. For each entity, the // response provides the entity text, entity type, where the entity text begins // and ends, and the level of confidence that Amazon Comprehend has in the detection. @@ -11430,6 +11961,10 @@ type DetectEntitiesOutput struct { // Entities (https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html) // in the Comprehend Developer Guide. Entities []*Entity `type:"list"` + + // Page-level errors that the system detected while processing the input document. + // The field is empty if the system encountered no errors. + Errors []*ErrorsListItem `type:"list"` } // String returns the string representation. @@ -11450,12 +11985,36 @@ func (s DetectEntitiesOutput) GoString() string { return s.String() } +// SetBlocks sets the Blocks field's value. +func (s *DetectEntitiesOutput) SetBlocks(v []*Block) *DetectEntitiesOutput { + s.Blocks = v + return s +} + +// SetDocumentMetadata sets the DocumentMetadata field's value. +func (s *DetectEntitiesOutput) SetDocumentMetadata(v *DocumentMetadata) *DetectEntitiesOutput { + s.DocumentMetadata = v + return s +} + +// SetDocumentType sets the DocumentType field's value. +func (s *DetectEntitiesOutput) SetDocumentType(v []*DocumentTypeListItem) *DetectEntitiesOutput { + s.DocumentType = v + return s +} + // SetEntities sets the Entities field's value. func (s *DetectEntitiesOutput) SetEntities(v []*Entity) *DetectEntitiesOutput { s.Entities = v return s } +// SetErrors sets the Errors field's value. +func (s *DetectEntitiesOutput) SetErrors(v []*ErrorsListItem) *DetectEntitiesOutput { + s.Errors = v + return s +} + type DetectKeyPhrasesInput struct { _ struct{} `type:"structure"` @@ -11979,6 +12538,10 @@ type DocumentClass struct { // The name of the class. Name *string `min:"1" type:"string"` + // Page number in the input document. This field is present in the response + // only if your request includes the Byte parameter. + Page *int64 `type:"integer"` + // The confidence score that Amazon Comprehend has this class correctly attributed. Score *float64 `type:"float"` } @@ -12007,6 +12570,12 @@ func (s *DocumentClass) SetName(v string) *DocumentClass { return s } +// SetPage sets the Page field's value. +func (s *DocumentClass) SetPage(v int64) *DocumentClass { + s.Page = &v + return s +} + // SetScore sets the Score field's value. func (s *DocumentClass) SetScore(v float64) *DocumentClass { s.Score = &v @@ -12799,6 +13368,10 @@ type DocumentLabel struct { // The name of the label. Name *string `min:"1" type:"string"` + // Page number where the label occurs. This field is present in the response + // only if your request includes the Byte parameter. + Page *int64 `type:"integer"` + // The confidence score that Amazon Comprehend has this label correctly attributed. Score *float64 `type:"float"` } @@ -12827,37 +13400,113 @@ func (s *DocumentLabel) SetName(v string) *DocumentLabel { return s } +// SetPage sets the Page field's value. +func (s *DocumentLabel) SetPage(v int64) *DocumentLabel { + s.Page = &v + return s +} + // SetScore sets the Score field's value. func (s *DocumentLabel) SetScore(v float64) *DocumentLabel { s.Score = &v return s } -// The input properties for a topic detection job. +// Information about the document, discovered during text extraction. +type DocumentMetadata struct { + _ struct{} `type:"structure"` + + // List of pages in the document, with the number of characters extracted from + // each page. + ExtractedCharacters []*ExtractedCharactersListItem `type:"list"` + + // Number of pages in the document. + Pages *int64 `type:"integer"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DocumentMetadata) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DocumentMetadata) GoString() string { + return s.String() +} + +// SetExtractedCharacters sets the ExtractedCharacters field's value. +func (s *DocumentMetadata) SetExtractedCharacters(v []*ExtractedCharactersListItem) *DocumentMetadata { + s.ExtractedCharacters = v + return s +} + +// SetPages sets the Pages field's value. +func (s *DocumentMetadata) SetPages(v int64) *DocumentMetadata { + s.Pages = &v + return s +} + +// Provides configuration parameters to override the default actions for extracting +// text from PDF documents and image files. +// +// By default, Amazon Comprehend performs the following actions to extract text +// from files, based on the input file type: +// +// - Word files - Amazon Comprehend parser extracts the text. +// +// - Digital PDF files - Amazon Comprehend parser extracts the text. +// +// - Image files and scanned PDF files - Amazon Comprehend uses the Amazon +// Textract DetectDocumentText API to extract the text. +// +// DocumentReaderConfig does not apply to plain text files or Word files. +// +// For image files and PDF documents, you can override these default actions +// using the fields listed below. For more information, see Setting text extraction +// options (https://docs.aws.amazon.com/comprehend/latest/dg/detecting-cer.html#detecting-cer-pdf). type DocumentReaderConfig struct { _ struct{} `type:"structure"` - // This enum field will start with two values which will apply to PDFs: + // This field defines the Amazon Textract API operation that Amazon Comprehend + // uses to extract text from PDF files and image files. Enter one of the following + // values: // - // * TEXTRACT_DETECT_DOCUMENT_TEXT - The service calls DetectDocumentText - // for PDF documents per page. + // * TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the + // DetectDocumentText API operation. // - // * TEXTRACT_ANALYZE_DOCUMENT - The service calls AnalyzeDocument for PDF - // documents per page. + // * TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument + // API operation. // // DocumentReadAction is a required field DocumentReadAction *string `type:"string" required:"true" enum:"DocumentReadAction"` - // This enum field provides two values: + // Determines the text extraction actions for PDF files. Enter one of the following + // values: // - // * SERVICE_DEFAULT - use service defaults for Document reading. For Digital - // PDF it would mean using an internal parser instead of Textract APIs + // * SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF + // files. // - // * FORCE_DOCUMENT_READ_ACTION - Always use specified action for DocumentReadAction, - // including Digital PDF. + // * FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API + // specified by DocumentReadAction for all PDF files, including digital PDF + // files. DocumentReadMode *string `type:"string" enum:"DocumentReadMode"` - // Specifies how the text in an input file should be processed: + // Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT + // as the read action, you must specify one or both of the following values: + // + // * TABLES - Returns information about any tables that are detected in the + // input document. + // + // * FORMS - Returns information and the data from any forms that are detected + // in the input document. FeatureTypes []*string `min:"1" type:"list" enum:"DocumentReadFeatureTypes"` } @@ -12913,6 +13562,47 @@ func (s *DocumentReaderConfig) SetFeatureTypes(v []*string) *DocumentReaderConfi return s } +// Document type for each page in the document. +type DocumentTypeListItem struct { + _ struct{} `type:"structure"` + + // Page number. + Page *int64 `type:"integer"` + + // Document type. + Type *string `type:"string" enum:"DocumentType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DocumentTypeListItem) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DocumentTypeListItem) GoString() string { + return s.String() +} + +// SetPage sets the Page field's value. +func (s *DocumentTypeListItem) SetPage(v int64) *DocumentTypeListItem { + s.Page = &v + return s +} + +// SetType sets the Type field's value. +func (s *DocumentTypeListItem) SetType(v string) *DocumentTypeListItem { + s.Type = &v + return s +} + // Returns the code for the dominant language in the input text and the level // of confidence that Amazon Comprehend has in the accuracy of the detection. type DominantLanguage struct { @@ -13635,10 +14325,18 @@ type Entity struct { // The zero-based offset from the beginning of the source text to the first // character in the entity. + // + // This field is empty for non-text input. BeginOffset *int64 `type:"integer"` + // A reference to each block for this entity. This field is empty for plain-text + // input. + BlockReferences []*BlockReference `type:"list"` + // The zero-based offset from the beginning of the source text to the last character // in the entity. + // + // This field is empty for non-text input. EndOffset *int64 `type:"integer"` // The level of confidence that Amazon Comprehend has in the accuracy of the @@ -13648,7 +14346,11 @@ type Entity struct { // The text of the entity. Text *string `min:"1" type:"string"` - // The entity's type. + // The entity type. For entity detection using the built-in model, this field + // contains one of the standard entity types listed below. + // + // For custom entity detection, this field contains one of the entity types + // that you specified when you trained your custom model. Type *string `type:"string" enum:"EntityType"` } @@ -13676,6 +14378,12 @@ func (s *Entity) SetBeginOffset(v int64) *Entity { return s } +// SetBlockReferences sets the BlockReferences field's value. +func (s *Entity) SetBlockReferences(v []*BlockReference) *Entity { + s.BlockReferences = v + return s +} + // SetEndOffset sets the EndOffset field's value. func (s *Entity) SetEndOffset(v int64) *Entity { s.EndOffset = &v @@ -14690,6 +15398,74 @@ func (s *EntityTypesListItem) SetType(v string) *EntityTypesListItem { return s } +// Text extraction encountered one or more page-level errors in the input document. +// +// The ErrorCode contains one of the following values: +// +// - TEXTRACT_BAD_PAGE - Amazon Textract cannot read the page. For more information +// about page limits in Amazon Textract, see Page Quotas in Amazon Textract +// (https://docs.aws.amazon.com/textract/latest/dg/limits-document.html). +// +// - TEXTRACT_PROVISIONED_THROUGHPUT_EXCEEDED - The number of requests exceeded +// your throughput limit. For more information about throughput quotas in +// Amazon Textract, see Default quotas in Amazon Textract (https://docs.aws.amazon.com/textract/latest/dg/limits-quotas-explained.html). +// +// - PAGE_CHARACTERS_EXCEEDED - Too many text characters on the page (10,000 +// characters maximum). +// +// - PAGE_SIZE_EXCEEDED - The maximum page size is 10 MB. +// +// - INTERNAL_SERVER_ERROR - The request encountered a service issue. Try +// the API request again. +type ErrorsListItem struct { + _ struct{} `type:"structure"` + + // Error code for the cause of the error. + ErrorCode *string `type:"string" enum:"PageBasedErrorCode"` + + // Text message explaining the reason for the error. + ErrorMessage *string `min:"1" type:"string"` + + // Page number where the error occurred. + Page *int64 `type:"integer"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ErrorsListItem) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ErrorsListItem) GoString() string { + return s.String() +} + +// SetErrorCode sets the ErrorCode field's value. +func (s *ErrorsListItem) SetErrorCode(v string) *ErrorsListItem { + s.ErrorCode = &v + return s +} + +// SetErrorMessage sets the ErrorMessage field's value. +func (s *ErrorsListItem) SetErrorMessage(v string) *ErrorsListItem { + s.ErrorMessage = &v + return s +} + +// SetPage sets the Page field's value. +func (s *ErrorsListItem) SetPage(v int64) *ErrorsListItem { + s.Page = &v + return s +} + // Provides information for filtering a list of event detection jobs. type EventsDetectionJobFilter struct { _ struct{} `type:"structure"` @@ -14909,6 +15685,92 @@ func (s *EventsDetectionJobProperties) SetTargetEventTypes(v []*string) *EventsD return s } +// Array of the number of characters extracted from each page. +type ExtractedCharactersListItem struct { + _ struct{} `type:"structure"` + + // Number of characters extracted from each page. + Count *int64 `type:"integer"` + + // Page number. + Page *int64 `type:"integer"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ExtractedCharactersListItem) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ExtractedCharactersListItem) GoString() string { + return s.String() +} + +// SetCount sets the Count field's value. +func (s *ExtractedCharactersListItem) SetCount(v int64) *ExtractedCharactersListItem { + s.Count = &v + return s +} + +// SetPage sets the Page field's value. +func (s *ExtractedCharactersListItem) SetPage(v int64) *ExtractedCharactersListItem { + s.Page = &v + return s +} + +// Information about the location of items on a document page. +// +// For additional information, see Geometry (https://docs.aws.amazon.com/textract/latest/dg/API_Geometry.html) +// in the Amazon Textract API reference. +type Geometry struct { + _ struct{} `type:"structure"` + + // An axis-aligned coarse representation of the location of the recognized item + // on the document page. + BoundingBox *BoundingBox `type:"structure"` + + // Within the bounding box, a fine-grained polygon around the recognized item. + Polygon []*Point `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Geometry) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Geometry) GoString() string { + return s.String() +} + +// SetBoundingBox sets the BoundingBox field's value. +func (s *Geometry) SetBoundingBox(v *BoundingBox) *Geometry { + s.BoundingBox = v + return s +} + +// SetPolygon sets the Polygon field's value. +func (s *Geometry) SetPolygon(v []*Point) *Geometry { + s.Polygon = v + return s +} + type ImportModelInput struct { _ struct{} `type:"structure"` @@ -15059,15 +15921,13 @@ func (s *ImportModelOutput) SetModelArn(v string) *ImportModelOutput { return s } -// The input properties for an inference job. +// The input properties for an inference job. The document reader config field +// applies only to non-text inputs for custom analysis. type InputDataConfig struct { _ struct{} `type:"structure"` - // The document reader config field applies only for InputDataConfig of StartEntitiesDetectionJob. - // - // Use DocumentReaderConfig to provide specifications about how you want your - // inference documents read. Currently it applies for PDF documents in StartEntitiesDetectionJob - // custom inference. + // Provides configuration parameters to override the default actions for extracting + // text from PDF documents and image files. DocumentReaderConfig *DocumentReaderConfig `type:"structure"` // Specifies how the text in an input file should be processed: @@ -15275,12 +16135,73 @@ func (s *InvalidFilterException) RequestID() string { return s.RespMetadata.RequestID } +// Provides additional detail about why the request failed: +// +// - Document size is too large - Check the size of your file and resubmit +// the request. +// +// - Document type is not supported - Check the file type and resubmit the +// request. +// +// - Too many pages in the document - Check the number of pages in your file +// and resubmit the request. +// +// - Access denied to Amazon Textract - Verify that your account has permission +// to use Amazon Textract API operations and resubmit the request. +type InvalidRequestDetail struct { + _ struct{} `type:"structure"` + + // Reason code is INVALID_DOCUMENT. + Reason *string `type:"string" enum:"InvalidRequestDetailReason"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InvalidRequestDetail) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InvalidRequestDetail) GoString() string { + return s.String() +} + +// SetReason sets the Reason field's value. +func (s *InvalidRequestDetail) SetReason(v string) *InvalidRequestDetail { + s.Reason = &v + return s +} + // The request is invalid. type InvalidRequestException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + // Provides additional detail about why the request failed: + // + // * Document size is too large - Check the size of your file and resubmit + // the request. + // + // * Document type is not supported - Check the file type and resubmit the + // request. + // + // * Too many pages in the document - Check the number of pages in your file + // and resubmit the request. + // + // * Access denied to Amazon Textract - Verify that your account has permission + // to use Amazon Textract API operations and resubmit the request. + Detail *InvalidRequestDetail `type:"structure"` + Message_ *string `locationName:"Message" min:"1" type:"string"` + + Reason *string `type:"string" enum:"InvalidRequestReason"` } // String returns the string representation. @@ -15326,7 +16247,7 @@ func (s *InvalidRequestException) OrigErr() error { } func (s *InvalidRequestException) Error() string { - return fmt.Sprintf("%s: %s", s.Code(), s.Message()) + return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) } // Status code returns the HTTP status code for the request's response error. @@ -17895,6 +18816,50 @@ func (s *PiiOutputDataConfig) SetS3Uri(v string) *PiiOutputDataConfig { return s } +// The X and Y coordinates of a point on a document page. +// +// For additional information, see Point (https://docs.aws.amazon.com/textract/latest/dg/API_Point.html) +// in the Amazon Textract API reference. +type Point struct { + _ struct{} `type:"structure"` + + // The value of the X coordinate for a point on a polygon + X *float64 `type:"float"` + + // The value of the Y coordinate for a point on a polygon + Y *float64 `type:"float"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Point) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Point) GoString() string { + return s.String() +} + +// SetX sets the X field's value. +func (s *Point) SetX(v float64) *Point { + s.X = &v + return s +} + +// SetY sets the Y field's value. +func (s *Point) SetY(v float64) *Point { + s.Y = &v + return s +} + type PutResourcePolicyInput struct { _ struct{} `type:"structure"` @@ -18077,6 +19042,47 @@ func (s *RedactionConfig) SetPiiEntityTypes(v []*string) *RedactionConfig { return s } +// List of child blocks for the current block. +type RelationshipsListItem struct { + _ struct{} `type:"structure"` + + // Identifers of the child blocks. + Ids []*string `type:"list"` + + // Only supported relationship is a child relationship. + Type *string `type:"string" enum:"RelationshipType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RelationshipsListItem) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RelationshipsListItem) GoString() string { + return s.String() +} + +// SetIds sets the Ids field's value. +func (s *RelationshipsListItem) SetIds(v []*string) *RelationshipsListItem { + s.Ids = v + return s +} + +// SetType sets the Type field's value. +func (s *RelationshipsListItem) SetType(v string) *RelationshipsListItem { + s.Type = &v + return s +} + // The specified resource name is already in use. Use a different name and try // your request again. type ResourceInUseException struct { @@ -20375,7 +21381,8 @@ type StartTargetedSentimentDetectionJobInput struct { // DataAccessRoleArn is a required field DataAccessRoleArn *string `min:"20" type:"string" required:"true"` - // The input properties for an inference job. + // The input properties for an inference job. The document reader config field + // applies only to non-text inputs for custom analysis. // // InputDataConfig is a required field InputDataConfig *InputDataConfig `type:"structure" required:"true"` @@ -21950,7 +22957,8 @@ type TargetedSentimentDetectionJobProperties struct { // The time that the targeted sentiment detection job ended. EndTime *time.Time `type:"timestamp"` - // The input properties for an inference job. + // The input properties for an inference job. The document reader config field + // applies only to non-text inputs for custom analysis. InputDataConfig *InputDataConfig `type:"structure"` // The Amazon Resource Name (ARN) of the targeted sentiment detection job. It @@ -23086,6 +24094,22 @@ func AugmentedManifestsDocumentTypeFormat_Values() []string { } } +const ( + // BlockTypeLine is a BlockType enum value + BlockTypeLine = "LINE" + + // BlockTypeWord is a BlockType enum value + BlockTypeWord = "WORD" +) + +// BlockType_Values returns all elements of the BlockType enum +func BlockType_Values() []string { + return []string{ + BlockTypeLine, + BlockTypeWord, + } +} + const ( // DocumentClassifierDataFormatComprehendCsv is a DocumentClassifierDataFormat enum value DocumentClassifierDataFormatComprehendCsv = "COMPREHEND_CSV" @@ -23134,14 +24158,14 @@ func DocumentReadAction_Values() []string { } } -// A list of the types of analyses to perform. This field specifies what feature -// types need to be extracted from the document where entity recognition is -// expected. +// Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT +// as the read action, you must specify one or both of the following values: // -// - TABLES - Add TABLES to the list to return information about the tables -// that are detected in the input document. +// - TABLES - Returns additional information about any tables that are detected +// in the input document. // -// - FORMS - Add FORMS to return detected form data. +// - FORMS - Returns additional information about any forms that are detected +// in the input document. const ( // DocumentReadFeatureTypesTables is a DocumentReadFeatureTypes enum value DocumentReadFeatureTypesTables = "TABLES" @@ -23174,6 +24198,42 @@ func DocumentReadMode_Values() []string { } } +const ( + // DocumentTypeNativePdf is a DocumentType enum value + DocumentTypeNativePdf = "NATIVE_PDF" + + // DocumentTypeScannedPdf is a DocumentType enum value + DocumentTypeScannedPdf = "SCANNED_PDF" + + // DocumentTypeMsWord is a DocumentType enum value + DocumentTypeMsWord = "MS_WORD" + + // DocumentTypeImage is a DocumentType enum value + DocumentTypeImage = "IMAGE" + + // DocumentTypePlainText is a DocumentType enum value + DocumentTypePlainText = "PLAIN_TEXT" + + // DocumentTypeTextractDetectDocumentTextJson is a DocumentType enum value + DocumentTypeTextractDetectDocumentTextJson = "TEXTRACT_DETECT_DOCUMENT_TEXT_JSON" + + // DocumentTypeTextractAnalyzeDocumentJson is a DocumentType enum value + DocumentTypeTextractAnalyzeDocumentJson = "TEXTRACT_ANALYZE_DOCUMENT_JSON" +) + +// DocumentType_Values returns all elements of the DocumentType enum +func DocumentType_Values() []string { + return []string{ + DocumentTypeNativePdf, + DocumentTypeScannedPdf, + DocumentTypeMsWord, + DocumentTypeImage, + DocumentTypePlainText, + DocumentTypeTextractDetectDocumentTextJson, + DocumentTypeTextractAnalyzeDocumentJson, + } +} + const ( // EndpointStatusCreating is a EndpointStatus enum value EndpointStatusCreating = "CREATING" @@ -23278,6 +24338,42 @@ func InputFormat_Values() []string { } } +const ( + // InvalidRequestDetailReasonDocumentSizeExceeded is a InvalidRequestDetailReason enum value + InvalidRequestDetailReasonDocumentSizeExceeded = "DOCUMENT_SIZE_EXCEEDED" + + // InvalidRequestDetailReasonUnsupportedDocType is a InvalidRequestDetailReason enum value + InvalidRequestDetailReasonUnsupportedDocType = "UNSUPPORTED_DOC_TYPE" + + // InvalidRequestDetailReasonPageLimitExceeded is a InvalidRequestDetailReason enum value + InvalidRequestDetailReasonPageLimitExceeded = "PAGE_LIMIT_EXCEEDED" + + // InvalidRequestDetailReasonTextractAccessDenied is a InvalidRequestDetailReason enum value + InvalidRequestDetailReasonTextractAccessDenied = "TEXTRACT_ACCESS_DENIED" +) + +// InvalidRequestDetailReason_Values returns all elements of the InvalidRequestDetailReason enum +func InvalidRequestDetailReason_Values() []string { + return []string{ + InvalidRequestDetailReasonDocumentSizeExceeded, + InvalidRequestDetailReasonUnsupportedDocType, + InvalidRequestDetailReasonPageLimitExceeded, + InvalidRequestDetailReasonTextractAccessDenied, + } +} + +const ( + // InvalidRequestReasonInvalidDocument is a InvalidRequestReason enum value + InvalidRequestReasonInvalidDocument = "INVALID_DOCUMENT" +) + +// InvalidRequestReason_Values returns all elements of the InvalidRequestReason enum +func InvalidRequestReason_Values() []string { + return []string{ + InvalidRequestReasonInvalidDocument, + } +} + const ( // JobStatusSubmitted is a JobStatus enum value JobStatusSubmitted = "SUBMITTED" @@ -23402,6 +24498,34 @@ func ModelStatus_Values() []string { } } +const ( + // PageBasedErrorCodeTextractBadPage is a PageBasedErrorCode enum value + PageBasedErrorCodeTextractBadPage = "TEXTRACT_BAD_PAGE" + + // PageBasedErrorCodeTextractProvisionedThroughputExceeded is a PageBasedErrorCode enum value + PageBasedErrorCodeTextractProvisionedThroughputExceeded = "TEXTRACT_PROVISIONED_THROUGHPUT_EXCEEDED" + + // PageBasedErrorCodePageCharactersExceeded is a PageBasedErrorCode enum value + PageBasedErrorCodePageCharactersExceeded = "PAGE_CHARACTERS_EXCEEDED" + + // PageBasedErrorCodePageSizeExceeded is a PageBasedErrorCode enum value + PageBasedErrorCodePageSizeExceeded = "PAGE_SIZE_EXCEEDED" + + // PageBasedErrorCodeInternalServerError is a PageBasedErrorCode enum value + PageBasedErrorCodeInternalServerError = "INTERNAL_SERVER_ERROR" +) + +// PageBasedErrorCode_Values returns all elements of the PageBasedErrorCode enum +func PageBasedErrorCode_Values() []string { + return []string{ + PageBasedErrorCodeTextractBadPage, + PageBasedErrorCodeTextractProvisionedThroughputExceeded, + PageBasedErrorCodePageCharactersExceeded, + PageBasedErrorCodePageSizeExceeded, + PageBasedErrorCodeInternalServerError, + } +} + const ( // PartOfSpeechTagTypeAdj is a PartOfSpeechTagType enum value PartOfSpeechTagTypeAdj = "ADJ" @@ -23670,6 +24794,18 @@ func PiiEntityType_Values() []string { } } +const ( + // RelationshipTypeChild is a RelationshipType enum value + RelationshipTypeChild = "CHILD" +) + +// RelationshipType_Values returns all elements of the RelationshipType enum +func RelationshipType_Values() []string { + return []string{ + RelationshipTypeChild, + } +} + const ( // SentimentTypePositive is a SentimentType enum value SentimentTypePositive = "POSITIVE" diff --git a/service/comprehend/comprehendiface/interface.go b/service/comprehend/comprehendiface/interface.go index 331f4f3b114..26deef3a5d1 100644 --- a/service/comprehend/comprehendiface/interface.go +++ b/service/comprehend/comprehendiface/interface.go @@ -236,6 +236,9 @@ type ComprehendAPI interface { ListEndpointsWithContext(aws.Context, *comprehend.ListEndpointsInput, ...request.Option) (*comprehend.ListEndpointsOutput, error) ListEndpointsRequest(*comprehend.ListEndpointsInput) (*request.Request, *comprehend.ListEndpointsOutput) + ListEndpointsPages(*comprehend.ListEndpointsInput, func(*comprehend.ListEndpointsOutput, bool) bool) error + ListEndpointsPagesWithContext(aws.Context, *comprehend.ListEndpointsInput, func(*comprehend.ListEndpointsOutput, bool) bool, ...request.Option) error + ListEntitiesDetectionJobs(*comprehend.ListEntitiesDetectionJobsInput) (*comprehend.ListEntitiesDetectionJobsOutput, error) ListEntitiesDetectionJobsWithContext(aws.Context, *comprehend.ListEntitiesDetectionJobsInput, ...request.Option) (*comprehend.ListEntitiesDetectionJobsOutput, error) ListEntitiesDetectionJobsRequest(*comprehend.ListEntitiesDetectionJobsInput) (*request.Request, *comprehend.ListEntitiesDetectionJobsOutput) @@ -275,6 +278,9 @@ type ComprehendAPI interface { ListPiiEntitiesDetectionJobsWithContext(aws.Context, *comprehend.ListPiiEntitiesDetectionJobsInput, ...request.Option) (*comprehend.ListPiiEntitiesDetectionJobsOutput, error) ListPiiEntitiesDetectionJobsRequest(*comprehend.ListPiiEntitiesDetectionJobsInput) (*request.Request, *comprehend.ListPiiEntitiesDetectionJobsOutput) + ListPiiEntitiesDetectionJobsPages(*comprehend.ListPiiEntitiesDetectionJobsInput, func(*comprehend.ListPiiEntitiesDetectionJobsOutput, bool) bool) error + ListPiiEntitiesDetectionJobsPagesWithContext(aws.Context, *comprehend.ListPiiEntitiesDetectionJobsInput, func(*comprehend.ListPiiEntitiesDetectionJobsOutput, bool) bool, ...request.Option) error + ListSentimentDetectionJobs(*comprehend.ListSentimentDetectionJobsInput) (*comprehend.ListSentimentDetectionJobsOutput, error) ListSentimentDetectionJobsWithContext(aws.Context, *comprehend.ListSentimentDetectionJobsInput, ...request.Option) (*comprehend.ListSentimentDetectionJobsOutput, error) ListSentimentDetectionJobsRequest(*comprehend.ListSentimentDetectionJobsInput) (*request.Request, *comprehend.ListSentimentDetectionJobsOutput) diff --git a/service/gamelift/api.go b/service/gamelift/api.go index 0a55ca0f4e4..6b1989795e3 100644 --- a/service/gamelift/api.go +++ b/service/gamelift/api.go @@ -87,11 +87,6 @@ func (c *GameLift) AcceptMatchRequest(input *AcceptMatchInput) (req *request.Req // FlexMatch events (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html) // (reference) // -// # Related actions -// -// StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch | -// StartMatchBackfill | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -106,8 +101,8 @@ func (c *GameLift) AcceptMatchRequest(input *AcceptMatchInput) (req *request.Req // parameter values before retrying. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - InternalServiceException // The service encountered an unrecoverable internal failure while processing @@ -200,10 +195,10 @@ func (c *GameLift) ClaimGameServerRequest(input *ClaimGameServerInput) (req *req // When a game server is successfully claimed, connection information is returned. // A claimed game server's utilization status remains AVAILABLE while the claim // status is set to CLAIMED for up to 60 seconds. This time period gives the -// game server time to update its status to UTILIZED (using UpdateGameServer) -// once players join. If the game server's status is not updated within 60 seconds, -// the game server reverts to unclaimed status and is available to be claimed -// by another request. The claim time period is a fixed value and is not configurable. +// game server time to update its status to UTILIZED after players join. If +// the game server's status is not updated within 60 seconds, the game server +// reverts to unclaimed status and is available to be claimed by another request. +// The claim time period is a fixed value and is not configurable. // // If you try to claim a specific game server, this request will fail in the // following cases: @@ -214,17 +209,12 @@ func (c *GameLift) ClaimGameServerRequest(input *ClaimGameServerInput) (req *req // // When claiming a specific game server, this request will succeed even if the // game server is running on an instance in DRAINING status. To avoid this, -// first check the instance status by calling DescribeGameServerInstances. +// first check the instance status by calling DescribeGameServerInstances (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameServerInstances.html) . // // # Learn more // // GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) // -// # Related actions -// -// RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer -// | UpdateGameServer | DeregisterGameServer | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/reference-awssdk-fleetiq.html) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -239,8 +229,8 @@ func (c *GameLift) ClaimGameServerRequest(input *ClaimGameServerInput) (req *req // parameter values before retrying. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - ConflictException // The requested operation would cause a conflict with the current state of @@ -345,8 +335,7 @@ func (c *GameLift) CreateAliasRequest(input *CreateAliasInput) (req *request.Req // // # Related actions // -// CreateAlias | ListAliases | DescribeAlias | UpdateAlias | DeleteAlias | ResolveAlias -// | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -449,32 +438,30 @@ func (c *GameLift) CreateBuildRequest(input *CreateBuildInput) (req *request.Req // CreateBuild API operation for Amazon GameLift. // // Creates a new Amazon GameLift build resource for your game server binary -// files. Game server binaries must be combined into a zip file for use with -// Amazon GameLift. +// files. Combine game server binaries into a zip file for use with Amazon GameLift. // -// When setting up a new game build for GameLift, we recommend using the Amazon -// Web Services CLI command upload-build (https://docs.aws.amazon.com/cli/latest/reference/gamelift/upload-build.html) +// When setting up a new game build for GameLift, we recommend using the CLI +// command upload-build (https://docs.aws.amazon.com/cli/latest/reference/gamelift/upload-build.html) // . This helper command combines two tasks: (1) it uploads your build files // from a file directory to a GameLift Amazon S3 location, and (2) it creates // a new build resource. // -// The CreateBuild operation can used in the following scenarios: +// You can use the operation in the following scenarios: // // - To create a new game build with build files that are in an Amazon S3 // location under an Amazon Web Services account that you control. To use -// this option, you must first give Amazon GameLift access to the Amazon -// S3 bucket. With permissions in place, call CreateBuild and specify a build -// name, operating system, and the Amazon S3 storage location of your game -// build. +// this option, you give Amazon GameLift access to the Amazon S3 bucket. +// With permissions in place, specify a build name, operating system, and +// the Amazon S3 storage location of your game build. // // - To directly upload your build files to a GameLift Amazon S3 location. -// To use this option, first call CreateBuild and specify a build name and -// operating system. This operation creates a new build resource and also -// returns an Amazon S3 location with temporary access credentials. Use the -// credentials to manually upload your build files to the specified Amazon -// S3 location. For more information, see Uploading Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/UploadingObjects.html) -// in the Amazon S3 Developer Guide. Build files can be uploaded to the GameLift -// Amazon S3 location once only; that can't be updated. +// To use this option, specify a build name and operating system. This operation +// creates a new build resource and also returns an Amazon S3 location with +// temporary access credentials. Use the credentials to manually upload your +// build files to the specified Amazon S3 location. For more information, +// see Uploading Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/UploadingObjects.html) +// in the Amazon S3 Developer Guide. After you upload build files to the +// GameLift Amazon S3 location, you can't update them. // // If successful, this operation creates a new build resource with a unique // build ID and places it in INITIALIZED status. A build must be in READY status @@ -486,10 +473,7 @@ func (c *GameLift) CreateBuildRequest(input *CreateBuildInput) (req *request.Req // // Create a Build with Files in Amazon S3 (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html#gamelift-build-cli-uploading-create-build) // -// # Related actions -// -// CreateBuild | ListBuilds | DescribeBuild | UpdateBuild | DeleteBuild | All -// APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -617,13 +601,6 @@ func (c *GameLift) CreateFleetRequest(input *CreateFleetInput) (req *request.Req // If successful, this operation creates a new Fleet resource and places it // in NEW status, which prompts GameLift to initiate the fleet creation workflow // (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creation-workflow.html). -// You can track fleet creation by checking fleet status using DescribeFleetAttributes -// and DescribeFleetLocationAttributes/, or by monitoring fleet creation events -// using DescribeFleetEvents. As soon as the fleet status changes to ACTIVE, -// you can enable automatic scaling for the fleet with PutScalingPolicy and -// set capacity for the home Region with UpdateFleetCapacity. When the status -// of each remote location reaches ACTIVE, you can set capacity by location -// using UpdateFleetCapacity. // // # Learn more // @@ -633,12 +610,6 @@ func (c *GameLift) CreateFleetRequest(input *CreateFleetInput) (req *request.Req // // Multi-location fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) // -// # Related actions -// -// CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits -// | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes -// | StopFleetActions | DeleteFleet | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -654,8 +625,8 @@ func (c *GameLift) CreateFleetRequest(input *CreateFleetInput) (req *request.Req // period. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - ConflictException // The requested operation would cause a conflict with the current state of @@ -752,8 +723,8 @@ func (c *GameLift) CreateFleetLocationsRequest(input *CreateFleetLocationsInput) // // This operation cannot be used with fleets that don't support remote locations. // Fleets can have multiple locations only if they reside in Amazon Web Services -// Regions that support this feature (see CreateFleet for the complete list) -// and were created after the feature was released in March 2021. +// Regions that support this feature and were created after the feature was +// released in March 2021. // // To add fleet locations, specify the fleet to be updated and provide a list // of one or more locations. @@ -761,10 +732,7 @@ func (c *GameLift) CreateFleetLocationsRequest(input *CreateFleetLocationsInput) // If successful, this operation returns the list of added locations with their // status set to NEW. GameLift initiates the process of starting an instance // in each added location. You can track the status of each new location by -// monitoring location creation events using DescribeFleetEvents. Alternatively, -// you can poll location status by calling DescribeFleetLocationAttributes. -// After a location status becomes ACTIVE, you can adjust the location's capacity -// as needed with UpdateFleetCapacity. +// monitoring location creation events using DescribeFleetEvents (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetEvents.html). // // # Learn more // @@ -772,13 +740,6 @@ func (c *GameLift) CreateFleetLocationsRequest(input *CreateFleetLocationsInput) // // Multi-location fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) // -// # Related actions -// -// CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity -// | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity -// | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions | DeleteFleetLocations -// | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -801,8 +762,8 @@ func (c *GameLift) CreateFleetLocationsRequest(input *CreateFleetLocationsInput) // The client failed authentication. Clients should not retry such requests. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - InvalidFleetStatusException // The requested operation would cause a conflict with the current state of @@ -812,6 +773,11 @@ func (c *GameLift) CreateFleetLocationsRequest(input *CreateFleetLocationsInput) // - UnsupportedRegionException // The requested operation is not supported in the Region specified. // +// - ConflictException +// The requested operation would cause a conflict with the current state of +// a service resource associated with the request. Resolve the conflict before +// retrying this request. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateFleetLocations func (c *GameLift) CreateFleetLocations(input *CreateFleetLocationsInput) (*CreateFleetLocationsOutput, error) { req, out := c.CreateFleetLocationsRequest(input) @@ -919,12 +885,6 @@ func (c *GameLift) CreateGameServerGroupRequest(input *CreateGameServerGroupInpu // // GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) // -// # Related actions -// -// CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup | -// UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup | SuspendGameServerGroup -// | DescribeGameServerInstances | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/reference-awssdk-fleetiq.html) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -1023,10 +983,9 @@ func (c *GameLift) CreateGameSessionRequest(input *CreateGameSessionInput) (req // Creates a multiplayer game session for players in a specific fleet location. // This operation prompts an available server process to start a game session // and retrieves connection information for the new game session. As an alternative, -// consider using the GameLift game session placement feature with -// -// with StartGameSessionPlacement, which uses FleetIQ algorithms and queues -// to optimize the placement process. +// consider using the GameLift game session placement feature with StartGameSessionPlacement +// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameSessionPlacement.html) +// , which uses FleetIQ algorithms and queues to optimize the placement process. // // When creating a game session, you specify exactly where you want to place // it and provide a set of game session configuration settings. The fleet must @@ -1046,11 +1005,12 @@ func (c *GameLift) CreateGameSessionRequest(input *CreateGameSessionInput) (req // When the status is ACTIVE, game session connection information is provided // and player sessions can be created for the game session. By default, newly // created game sessions are open to new players. You can restrict new player -// access by using UpdateGameSession to change the game session's player session -// creation policy. +// access by using UpdateGameSession (https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSession.html) +// to change the game session's player session creation policy. // // Game session logs are retained for all active game sessions for 14 days. -// To access the logs, call GetGameSessionLogUrl to download the log files. +// To access the logs, call GetGameSessionLogUrl (https://docs.aws.amazon.com/gamelift/latest/apireference/API_GetGameSessionLogUrl.html) +// to download the log files. // // Available in Amazon GameLift Local. // @@ -1058,12 +1018,7 @@ func (c *GameLift) CreateGameSessionRequest(input *CreateGameSessionInput) (req // // Start a game session (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession) // -// # Related actions -// -// CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions -// | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | -// DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1104,8 +1059,8 @@ func (c *GameLift) CreateGameSessionRequest(input *CreateGameSessionInput) (req // parameter values before retrying. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - FleetCapacityExceededException // The specified fleet has no available instances to fulfill a CreateGameSession @@ -1259,8 +1214,8 @@ func (c *GameLift) CreateGameSessionQueueRequest(input *CreateGameSessionQueueIn // limit. Resolve the issue before retrying. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - TaggingFailedException // The requested tagging operation did not succeed. This may be due to invalid @@ -1289,6 +1244,108 @@ func (c *GameLift) CreateGameSessionQueueWithContext(ctx aws.Context, input *Cre return out, req.Send() } +const opCreateLocation = "CreateLocation" + +// CreateLocationRequest generates a "aws/request.Request" representing the +// client's request for the CreateLocation operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateLocation for more information on using the CreateLocation +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the CreateLocationRequest method. +// req, resp := client.CreateLocationRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateLocation +func (c *GameLift) CreateLocationRequest(input *CreateLocationInput) (req *request.Request, output *CreateLocationOutput) { + op := &request.Operation{ + Name: opCreateLocation, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &CreateLocationInput{} + } + + output = &CreateLocationOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateLocation API operation for Amazon GameLift. +// +// Creates a custom location for use in an Anywhere fleet. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon GameLift's +// API operation CreateLocation for usage and error information. +// +// Returned Error Types: +// +// - UnauthorizedException +// The client failed authentication. Clients should not retry such requests. +// +// - InvalidRequestException +// One or more parameter values in the request are invalid. Correct the invalid +// parameter values before retrying. +// +// - LimitExceededException +// The requested operation would cause the resource to exceed the allowed service +// limit. Resolve the issue before retrying. +// +// - ConflictException +// The requested operation would cause a conflict with the current state of +// a service resource associated with the request. Resolve the conflict before +// retrying this request. +// +// - TaggingFailedException +// The requested tagging operation did not succeed. This may be due to invalid +// tag format or the maximum tag limit may have been exceeded. Resolve the issue +// before retrying. +// +// - InternalServiceException +// The service encountered an unrecoverable internal failure while processing +// the request. Clients can retry such requests immediately or after a waiting +// period. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateLocation +func (c *GameLift) CreateLocation(input *CreateLocationInput) (*CreateLocationOutput, error) { + req, out := c.CreateLocationRequest(input) + return out, req.Send() +} + +// CreateLocationWithContext is the same as CreateLocation with the addition of +// the ability to pass a context and additional request options. +// +// See CreateLocation for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *GameLift) CreateLocationWithContext(ctx aws.Context, input *CreateLocationInput, opts ...request.Option) (*CreateLocationOutput, error) { + req, out := c.CreateLocationRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opCreateMatchmakingConfiguration = "CreateMatchmakingConfiguration" // CreateMatchmakingConfigurationRequest generates a "aws/request.Request" representing the @@ -1338,8 +1395,8 @@ func (c *GameLift) CreateMatchmakingConfigurationRequest(input *CreateMatchmakin // and forming teams. If you're also using GameLift hosting, it defines how // to start game sessions for each match. Your matchmaking system can use multiple // configurations to handle different game scenarios. All matchmaking requests -// (StartMatchmaking or StartMatchBackfill) identify the matchmaking configuration -// to use and provide player attributes consistent with that configuration. +// identify the matchmaking configuration to use and provide player attributes +// consistent with that configuration. // // To create a matchmaking configuration, you must provide the following: configuration // name and FlexMatch mode (with or without GameLift hosting); a rule set that @@ -1350,9 +1407,7 @@ func (c *GameLift) CreateMatchmakingConfigurationRequest(input *CreateMatchmakin // // In addition, you must set up an Amazon Simple Notification Service topic // to receive matchmaking notifications. Provide the topic ARN in the matchmaking -// configuration. An alternative method, continuously polling ticket status -// with DescribeMatchmaking, is only suitable for games in development with -// low matchmaking usage. +// configuration. // // Learn more // @@ -1360,13 +1415,6 @@ func (c *GameLift) CreateMatchmakingConfigurationRequest(input *CreateMatchmakin // // Set up FlexMatch event notification (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html) // -// # Related actions -// -// CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations | UpdateMatchmakingConfiguration -// | DeleteMatchmakingConfiguration | CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets -// | ValidateMatchmakingRuleSet | DeleteMatchmakingRuleSet | All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -1385,8 +1433,8 @@ func (c *GameLift) CreateMatchmakingConfigurationRequest(input *CreateMatchmakin // limit. Resolve the issue before retrying. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - InternalServiceException // The service encountered an unrecoverable internal failure while processing @@ -1469,15 +1517,15 @@ func (c *GameLift) CreateMatchmakingRuleSetRequest(input *CreateMatchmakingRuleS // Creates a new rule set for FlexMatch matchmaking. A rule set describes the // type of match to create, such as the number and size of teams. It also sets // the parameters for acceptable player matches, such as minimum skill level -// or character type. A rule set is used by a MatchmakingConfiguration. +// or character type. // // To create a matchmaking rule set, provide unique rule set name and the rule // set body in JSON format. Rule sets must be defined in the same Region as // the matchmaking configuration they are used with. // // Since matchmaking rule sets cannot be edited, it is a good idea to check -// the rule set syntax using ValidateMatchmakingRuleSet before creating a new -// rule set. +// the rule set syntax using ValidateMatchmakingRuleSet (https://docs.aws.amazon.com/gamelift/latest/apireference/API_ValidateMatchmakingRuleSet.html) +// before creating a new rule set. // // Learn more // @@ -1487,13 +1535,6 @@ func (c *GameLift) CreateMatchmakingRuleSetRequest(input *CreateMatchmakingRuleS // // - Matchmaking with FlexMatch (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-intro.html) // -// # Related actions -// -// CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations | UpdateMatchmakingConfiguration -// | DeleteMatchmakingConfiguration | CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets -// | ValidateMatchmakingRuleSet | DeleteMatchmakingRuleSet | All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -1507,6 +1548,10 @@ func (c *GameLift) CreateMatchmakingRuleSetRequest(input *CreateMatchmakingRuleS // One or more parameter values in the request are invalid. Correct the invalid // parameter values before retrying. // +// - LimitExceededException +// The requested operation would cause the resource to exceed the allowed service +// limit. Resolve the issue before retrying. +// // - InternalServiceException // The service encountered an unrecoverable internal failure while processing // the request. Clients can retry such requests immediately or after a waiting @@ -1588,25 +1633,22 @@ func (c *GameLift) CreatePlayerSessionRequest(input *CreatePlayerSessionInput) ( // Reserves an open player slot in a game session for a player. New player sessions // can be created in any game session with an open slot that is in ACTIVE status // and has a player creation policy of ACCEPT_ALL. You can add a group of players -// to a game session with CreatePlayerSessions. +// to a game session with CreatePlayerSessions (https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreatePlayerSessions.html) . // // To create a player session, specify a game session ID, player ID, and optionally // a set of player data. // // If successful, a slot is reserved in the game session for the player and -// a new PlayerSession object is returned with a player session ID. The player +// a new PlayerSessions object is returned with a player session ID. The player // references the player session ID when sending a connection request to the // game session, and the game server can use it to validate the player reservation // with the GameLift service. Player sessions cannot be updated. // // The maximum number of players per game session is 200. It is not adjustable. // -// Available in Amazon GameLift Local. -// // # Related actions // -// CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions | StartGameSessionPlacement -// | DescribeGameSessionPlacement | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1646,8 +1688,8 @@ func (c *GameLift) CreatePlayerSessionRequest(input *CreatePlayerSessionInput) ( // parameter values before retrying. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreatePlayerSession func (c *GameLift) CreatePlayerSession(input *CreatePlayerSessionInput) (*CreatePlayerSessionOutput, error) { @@ -1717,7 +1759,7 @@ func (c *GameLift) CreatePlayerSessionsRequest(input *CreatePlayerSessionsInput) // Reserves open slots in a game session for a group of players. New player // sessions can be created in any game session with an open slot that is in // ACTIVE status and has a player creation policy of ACCEPT_ALL. To add a single -// player to a game session, use CreatePlayerSession. +// player to a game session, use CreatePlayerSession (https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreatePlayerSession.html) // // To create player sessions, specify a game session ID and a list of player // IDs. Optionally, provide a set of player data for each player ID. @@ -1730,12 +1772,9 @@ func (c *GameLift) CreatePlayerSessionsRequest(input *CreatePlayerSessionsInput) // // The maximum number of players per game session is 200. It is not adjustable. // -// Available in Amazon GameLift Local. -// // # Related actions // -// CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions | StartGameSessionPlacement -// | DescribeGameSessionPlacement | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1775,8 +1814,8 @@ func (c *GameLift) CreatePlayerSessionsRequest(input *CreatePlayerSessionsInput) // parameter values before retrying. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreatePlayerSessions func (c *GameLift) CreatePlayerSessions(input *CreatePlayerSessionsInput) (*CreatePlayerSessionsOutput, error) { @@ -1874,8 +1913,7 @@ func (c *GameLift) CreateScriptRequest(input *CreateScriptInput) (req *request.R // // # Related actions // -// CreateScript | ListScripts | DescribeScript | UpdateScript | DeleteScript -// | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1976,10 +2014,10 @@ func (c *GameLift) CreateVpcPeeringAuthorizationRequest(input *CreateVpcPeeringA // Requests authorization to create or delete a peer connection between the // VPC for your Amazon GameLift fleet and a virtual private cloud (VPC) in your // Amazon Web Services account. VPC peering enables the game servers on your -// fleet to communicate directly with other Amazon Web Services resources. Once -// you've received authorization, call CreateVpcPeeringConnection to establish -// the peering connection. For more information, see VPC Peering with Amazon -// GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html). +// fleet to communicate directly with other Amazon Web Services resources. After +// you've received authorization, use CreateVpcPeeringConnection (https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateVpcPeeringConnection.html) +// to establish the peering connection. For more information, see VPC Peering +// with Amazon GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html). // // You can peer with VPCs that are owned by any Amazon Web Services account // you have access to, including the account that you use to manage your Amazon @@ -2000,15 +2038,12 @@ func (c *GameLift) CreateVpcPeeringAuthorizationRequest(input *CreateVpcPeeringA // delete the peering connection for, and (2) ID of the Amazon Web Services // account that you use to manage Amazon GameLift. // -// The authorization remains valid for 24 hours unless it is canceled by a call -// to DeleteVpcPeeringAuthorization. You must create or delete the peering connection -// while the authorization is valid. +// The authorization remains valid for 24 hours unless it is canceled. You must +// create or delete the peering connection while the authorization is valid. // // # Related actions // -// CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | DeleteVpcPeeringAuthorization -// | CreateVpcPeeringConnection | DescribeVpcPeeringConnections | DeleteVpcPeeringConnection -// | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2027,8 +2062,8 @@ func (c *GameLift) CreateVpcPeeringAuthorizationRequest(input *CreateVpcPeeringA // parameter values before retrying. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - InternalServiceException // The service encountered an unrecoverable internal failure while processing @@ -2111,26 +2146,26 @@ func (c *GameLift) CreateVpcPeeringConnectionRequest(input *CreateVpcPeeringConn // Amazon GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html). // // Before calling this operation to establish the peering connection, you first -// need to call CreateVpcPeeringAuthorization and identify the VPC you want -// to peer with. Once the authorization for the specified VPC is issued, you -// have 24 hours to establish the connection. These two operations handle all -// tasks necessary to peer the two VPCs, including acceptance, updating routing -// tables, etc. +// need to use CreateVpcPeeringAuthorization (https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateVpcPeeringAuthorization.html) +// and identify the VPC you want to peer with. Once the authorization for the +// specified VPC is issued, you have 24 hours to establish the connection. These +// two operations handle all tasks necessary to peer the two VPCs, including +// acceptance, updating routing tables, etc. // // To establish the connection, call this operation from the Amazon Web Services // account that is used to manage the Amazon GameLift fleets. Identify the following // values: (1) The ID of the fleet you want to be enable a VPC peering connection // for; (2) The Amazon Web Services account with the VPC that you want to peer // with; and (3) The ID of the VPC you want to peer with. This operation is -// asynchronous. If successful, a VpcPeeringConnection request is created. You -// can use continuous polling to track the request's status using DescribeVpcPeeringConnections, -// or by monitoring fleet events for success or failure using DescribeFleetEvents. +// asynchronous. If successful, a connection request is created. You can use +// continuous polling to track the request's status using DescribeVpcPeeringConnections +// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeVpcPeeringConnections.html) +// , or by monitoring fleet events for success or failure using DescribeFleetEvents +// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetEvents.html) . // // # Related actions // -// CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | DeleteVpcPeeringAuthorization -// | CreateVpcPeeringConnection | DescribeVpcPeeringConnections | DeleteVpcPeeringConnection -// | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2149,8 +2184,8 @@ func (c *GameLift) CreateVpcPeeringConnectionRequest(input *CreateVpcPeeringConn // parameter values before retrying. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - InternalServiceException // The service encountered an unrecoverable internal failure while processing @@ -2229,8 +2264,7 @@ func (c *GameLift) DeleteAliasRequest(input *DeleteAliasInput) (req *request.Req // // # Related actions // -// CreateAlias | ListAliases | DescribeAlias | UpdateAlias | DeleteAlias | ResolveAlias -// | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2245,8 +2279,8 @@ func (c *GameLift) DeleteAliasRequest(input *DeleteAliasInput) (req *request.Req // The client failed authentication. Clients should not retry such requests. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - InvalidRequestException // One or more parameter values in the request are invalid. Correct the invalid @@ -2339,10 +2373,7 @@ func (c *GameLift) DeleteBuildRequest(input *DeleteBuildInput) (req *request.Req // // Upload a Custom Server Build (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html) // -// # Related actions -// -// CreateBuild | ListBuilds | DescribeBuild | UpdateBuild | DeleteBuild | All -// APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2357,8 +2388,8 @@ func (c *GameLift) DeleteBuildRequest(input *DeleteBuildInput) (req *request.Req // The client failed authentication. Clients should not retry such requests. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - InternalServiceException // The service encountered an unrecoverable internal failure while processing @@ -2445,9 +2476,9 @@ func (c *GameLift) DeleteFleetRequest(input *DeleteFleetInput) (req *request.Req // need to call DeleteFleetLocations separately. // // If the fleet being deleted has a VPC peering connection, you first need to -// get a valid authorization (good for 24 hours) by calling CreateVpcPeeringAuthorization. -// You do not need to explicitly delete the VPC peering connection--this is -// done as part of the delete fleet process. +// get a valid authorization (good for 24 hours) by calling CreateVpcPeeringAuthorization +// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateVpcPeeringAuthorization.html). +// You do not need to explicitly delete the VPC peering connection. // // To delete a fleet, specify the fleet ID to be terminated. During the deletion // process the fleet status is changed to DELETING. When completed, the status @@ -2457,13 +2488,6 @@ func (c *GameLift) DeleteFleetRequest(input *DeleteFleetInput) (req *request.Req // // Setting up GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) // -// # Related actions -// -// CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity | UpdateFleetPortSettings -// | UpdateRuntimeConfiguration | StopFleetActions | StartFleetActions | PutScalingPolicy -// | DeleteFleet | DeleteFleetLocations | DeleteScalingPolicy | All APIs by -// task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -2474,8 +2498,8 @@ func (c *GameLift) DeleteFleetRequest(input *DeleteFleetInput) (req *request.Req // Returned Error Types: // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - InternalServiceException // The service encountered an unrecoverable internal failure while processing @@ -2579,13 +2603,6 @@ func (c *GameLift) DeleteFleetLocationsRequest(input *DeleteFleetLocationsInput) // // Setting up GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) // -// # Related actions -// -// CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity -// | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity -// | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions | DeleteFleetLocations -// | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -2608,8 +2625,8 @@ func (c *GameLift) DeleteFleetLocationsRequest(input *DeleteFleetLocationsInput) // The client failed authentication. Clients should not retry such requests. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - UnsupportedRegionException // The requested operation is not supported in the Region specified. @@ -2710,12 +2727,6 @@ func (c *GameLift) DeleteGameServerGroupRequest(input *DeleteGameServerGroupInpu // // GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) // -// # Related actions -// -// CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup | -// UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup | SuspendGameServerGroup -// | DescribeGameServerInstances | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/reference-awssdk-fleetiq.html) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -2730,8 +2741,8 @@ func (c *GameLift) DeleteGameServerGroupRequest(input *DeleteGameServerGroupInpu // parameter values before retrying. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - UnauthorizedException // The client failed authentication. Clients should not retry such requests. @@ -2812,18 +2823,6 @@ func (c *GameLift) DeleteGameSessionQueueRequest(input *DeleteGameSessionQueueIn // requests that reference the queue will fail. To delete a queue, specify the // queue name. // -// Learn more -// -// Using Multi-Region Queues (https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html) -// -// # Related actions -// -// CreateGameSessionQueue (https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateGameSessionQueue.html) -// | DescribeGameSessionQueues (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionQueues.html) -// | UpdateGameSessionQueue (https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSessionQueue.html) -// | DeleteGameSessionQueue (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteGameSessionQueue.html) -// | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -2843,8 +2842,8 @@ func (c *GameLift) DeleteGameSessionQueueRequest(input *DeleteGameSessionQueueIn // parameter values before retrying. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - UnauthorizedException // The client failed authentication. Clients should not retry such requests. @@ -2876,6 +2875,103 @@ func (c *GameLift) DeleteGameSessionQueueWithContext(ctx aws.Context, input *Del return out, req.Send() } +const opDeleteLocation = "DeleteLocation" + +// DeleteLocationRequest generates a "aws/request.Request" representing the +// client's request for the DeleteLocation operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteLocation for more information on using the DeleteLocation +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the DeleteLocationRequest method. +// req, resp := client.DeleteLocationRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteLocation +func (c *GameLift) DeleteLocationRequest(input *DeleteLocationInput) (req *request.Request, output *DeleteLocationOutput) { + op := &request.Operation{ + Name: opDeleteLocation, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DeleteLocationInput{} + } + + output = &DeleteLocationOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// DeleteLocation API operation for Amazon GameLift. +// +// Deletes a custom location. +// +// Before deleting a custom location, review any fleets currently using the +// custom location and deregister the location if it is in use. For more information +// see, DeregisterCompute (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeregisterCompute.html). +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon GameLift's +// API operation DeleteLocation for usage and error information. +// +// Returned Error Types: +// +// - UnauthorizedException +// The client failed authentication. Clients should not retry such requests. +// +// - InvalidRequestException +// One or more parameter values in the request are invalid. Correct the invalid +// parameter values before retrying. +// +// - NotFoundException +// THe requested resources was not found. The resource was either not created +// yet or deleted. +// +// - InternalServiceException +// The service encountered an unrecoverable internal failure while processing +// the request. Clients can retry such requests immediately or after a waiting +// period. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteLocation +func (c *GameLift) DeleteLocation(input *DeleteLocationInput) (*DeleteLocationOutput, error) { + req, out := c.DeleteLocationRequest(input) + return out, req.Send() +} + +// DeleteLocationWithContext is the same as DeleteLocation with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteLocation for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *GameLift) DeleteLocationWithContext(ctx aws.Context, input *DeleteLocationInput, opts ...request.Option) (*DeleteLocationOutput, error) { + req, out := c.DeleteLocationRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDeleteMatchmakingConfiguration = "DeleteMatchmakingConfiguration" // DeleteMatchmakingConfigurationRequest generates a "aws/request.Request" representing the @@ -2924,13 +3020,6 @@ func (c *GameLift) DeleteMatchmakingConfigurationRequest(input *DeleteMatchmakin // the configuration name. A matchmaking configuration cannot be deleted if // it is being used in any active matchmaking tickets. // -// # Related actions -// -// CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations | UpdateMatchmakingConfiguration -// | DeleteMatchmakingConfiguration | CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets -// | ValidateMatchmakingRuleSet | DeleteMatchmakingRuleSet | All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -2945,8 +3034,8 @@ func (c *GameLift) DeleteMatchmakingConfigurationRequest(input *DeleteMatchmakin // parameter values before retrying. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - InternalServiceException // The service encountered an unrecoverable internal failure while processing @@ -3035,13 +3124,6 @@ func (c *GameLift) DeleteMatchmakingRuleSetRequest(input *DeleteMatchmakingRuleS // // - Build a rule set (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html) // -// # Related actions -// -// CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations | UpdateMatchmakingConfiguration -// | DeleteMatchmakingConfiguration | CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets -// | ValidateMatchmakingRuleSet | DeleteMatchmakingRuleSet | All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -3064,8 +3146,8 @@ func (c *GameLift) DeleteMatchmakingRuleSetRequest(input *DeleteMatchmakingRuleS // The requested operation is not supported in the Region specified. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - TaggingFailedException // The requested tagging operation did not succeed. This may be due to invalid @@ -3142,14 +3224,8 @@ func (c *GameLift) DeleteScalingPolicyRequest(input *DeleteScalingPolicyInput) ( // force and GameLift removes all record of it. To delete a scaling policy, // specify both the scaling policy name and the fleet ID it is associated with. // -// To temporarily suspend scaling policies, call StopFleetActions. This operation -// suspends all policies for the fleet. -// -// # Related actions -// -// DescribeFleetCapacity | UpdateFleetCapacity | DescribeEC2InstanceLimits | -// PutScalingPolicy | DescribeScalingPolicies | DeleteScalingPolicy | StopFleetActions -// | StartFleetActions | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// To temporarily suspend scaling policies, use StopFleetActions (https://docs.aws.amazon.com/gamelift/latest/apireference/API_StopFleetActions.html). +// This operation suspends all policies for the fleet. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3173,8 +3249,8 @@ func (c *GameLift) DeleteScalingPolicyRequest(input *DeleteScalingPolicyInput) ( // The client failed authentication. Clients should not retry such requests. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteScalingPolicy func (c *GameLift) DeleteScalingPolicy(input *DeleteScalingPolicyInput) (*DeleteScalingPolicyOutput, error) { @@ -3258,8 +3334,7 @@ func (c *GameLift) DeleteScriptRequest(input *DeleteScriptInput) (req *request.R // // # Related actions // -// CreateScript | ListScripts | DescribeScript | UpdateScript | DeleteScript -// | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3278,8 +3353,8 @@ func (c *GameLift) DeleteScriptRequest(input *DeleteScriptInput) (req *request.R // The client failed authentication. Clients should not retry such requests. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - TaggingFailedException // The requested tagging operation did not succeed. This may be due to invalid @@ -3358,13 +3433,12 @@ func (c *GameLift) DeleteVpcPeeringAuthorizationRequest(input *DeleteVpcPeeringA // DeleteVpcPeeringAuthorization API operation for Amazon GameLift. // // Cancels a pending VPC peering authorization for the specified VPC. If you -// need to delete an existing VPC peering connection, call DeleteVpcPeeringConnection. +// need to delete an existing VPC peering connection, use DeleteVpcPeeringConnection +// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteVpcPeeringConnection.html). // // # Related actions // -// CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | DeleteVpcPeeringAuthorization -// | CreateVpcPeeringConnection | DescribeVpcPeeringConnections | DeleteVpcPeeringConnection -// | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3383,8 +3457,8 @@ func (c *GameLift) DeleteVpcPeeringAuthorizationRequest(input *DeleteVpcPeeringA // parameter values before retrying. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - InternalServiceException // The service encountered an unrecoverable internal failure while processing @@ -3458,9 +3532,7 @@ func (c *GameLift) DeleteVpcPeeringConnectionRequest(input *DeleteVpcPeeringConn // DeleteVpcPeeringConnection API operation for Amazon GameLift. // // Removes a VPC peering connection. To delete the connection, you must have -// a valid authorization for the VPC peering connection that you want to delete. -// You can check for an authorization by calling DescribeVpcPeeringAuthorizations -// or request a new one using CreateVpcPeeringAuthorization. +// a valid authorization for the VPC peering connection that you want to delete.. // // Once a valid authorization exists, call this operation from the Amazon Web // Services account that is used to manage the Amazon GameLift fleets. Identify @@ -3469,9 +3541,7 @@ func (c *GameLift) DeleteVpcPeeringConnectionRequest(input *DeleteVpcPeeringConn // // # Related actions // -// CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | DeleteVpcPeeringAuthorization -// | CreateVpcPeeringConnection | DescribeVpcPeeringConnections | DeleteVpcPeeringConnection -// | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3490,8 +3560,8 @@ func (c *GameLift) DeleteVpcPeeringConnectionRequest(input *DeleteVpcPeeringConn // parameter values before retrying. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - InternalServiceException // The service encountered an unrecoverable internal failure while processing @@ -3520,70 +3590,159 @@ func (c *GameLift) DeleteVpcPeeringConnectionWithContext(ctx aws.Context, input return out, req.Send() } -const opDeregisterGameServer = "DeregisterGameServer" +const opDeregisterCompute = "DeregisterCompute" -// DeregisterGameServerRequest generates a "aws/request.Request" representing the -// client's request for the DeregisterGameServer operation. The "output" return +// DeregisterComputeRequest generates a "aws/request.Request" representing the +// client's request for the DeregisterCompute operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See DeregisterGameServer for more information on using the DeregisterGameServer +// See DeregisterCompute for more information on using the DeregisterCompute // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // -// // Example sending a request using the DeregisterGameServerRequest method. -// req, resp := client.DeregisterGameServerRequest(params) +// // Example sending a request using the DeregisterComputeRequest method. +// req, resp := client.DeregisterComputeRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeregisterGameServer -func (c *GameLift) DeregisterGameServerRequest(input *DeregisterGameServerInput) (req *request.Request, output *DeregisterGameServerOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeregisterCompute +func (c *GameLift) DeregisterComputeRequest(input *DeregisterComputeInput) (req *request.Request, output *DeregisterComputeOutput) { op := &request.Operation{ - Name: opDeregisterGameServer, + Name: opDeregisterCompute, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &DeregisterGameServerInput{} + input = &DeregisterComputeInput{} } - output = &DeregisterGameServerOutput{} + output = &DeregisterComputeOutput{} req = c.newRequest(op, input, output) req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// DeregisterGameServer API operation for Amazon GameLift. +// DeregisterCompute API operation for Amazon GameLift. // -// This operation is used with the GameLift FleetIQ solution and game server -// groups. +// Removes a compute resource from the specified fleet. Deregister your compute +// resources before you delete the compute. // -// Removes the game server from a game server group. As a result of this operation, -// the deregistered game server can no longer be claimed and will not be returned -// in a list of active game servers. +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. // -// To deregister a game server, specify the game server group and game server -// ID. If successful, this operation emits a CloudWatch event with termination +// See the AWS API reference guide for Amazon GameLift's +// API operation DeregisterCompute for usage and error information. +// +// Returned Error Types: +// +// - UnauthorizedException +// The client failed authentication. Clients should not retry such requests. +// +// - InvalidRequestException +// One or more parameter values in the request are invalid. Correct the invalid +// parameter values before retrying. +// +// - NotFoundException +// THe requested resources was not found. The resource was either not created +// yet or deleted. +// +// - InternalServiceException +// The service encountered an unrecoverable internal failure while processing +// the request. Clients can retry such requests immediately or after a waiting +// period. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeregisterCompute +func (c *GameLift) DeregisterCompute(input *DeregisterComputeInput) (*DeregisterComputeOutput, error) { + req, out := c.DeregisterComputeRequest(input) + return out, req.Send() +} + +// DeregisterComputeWithContext is the same as DeregisterCompute with the addition of +// the ability to pass a context and additional request options. +// +// See DeregisterCompute for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *GameLift) DeregisterComputeWithContext(ctx aws.Context, input *DeregisterComputeInput, opts ...request.Option) (*DeregisterComputeOutput, error) { + req, out := c.DeregisterComputeRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDeregisterGameServer = "DeregisterGameServer" + +// DeregisterGameServerRequest generates a "aws/request.Request" representing the +// client's request for the DeregisterGameServer operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeregisterGameServer for more information on using the DeregisterGameServer +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the DeregisterGameServerRequest method. +// req, resp := client.DeregisterGameServerRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeregisterGameServer +func (c *GameLift) DeregisterGameServerRequest(input *DeregisterGameServerInput) (req *request.Request, output *DeregisterGameServerOutput) { + op := &request.Operation{ + Name: opDeregisterGameServer, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DeregisterGameServerInput{} + } + + output = &DeregisterGameServerOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// DeregisterGameServer API operation for Amazon GameLift. +// +// This operation is used with the GameLift FleetIQ solution and game server +// groups. +// +// Removes the game server from a game server group. As a result of this operation, +// the deregistered game server can no longer be claimed and will not be returned +// in a list of active game servers. +// +// To deregister a game server, specify the game server group and game server +// ID. If successful, this operation emits a CloudWatch event with termination // timestamp and reason. // // # Learn more // // GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) // -// # Related actions -// -// RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer -// | UpdateGameServer | DeregisterGameServer | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/reference-awssdk-fleetiq.html) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -3598,8 +3757,8 @@ func (c *GameLift) DeregisterGameServerRequest(input *DeregisterGameServerInput) // parameter values before retrying. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - UnauthorizedException // The client failed authentication. Clients should not retry such requests. @@ -3682,8 +3841,7 @@ func (c *GameLift) DescribeAliasRequest(input *DescribeAliasInput) (req *request // // # Related actions // -// CreateAlias | ListAliases | DescribeAlias | UpdateAlias | DeleteAlias | ResolveAlias -// | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3702,8 +3860,8 @@ func (c *GameLift) DescribeAliasRequest(input *DescribeAliasInput) (req *request // parameter values before retrying. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - InternalServiceException // The service encountered an unrecoverable internal failure while processing @@ -3783,10 +3941,7 @@ func (c *GameLift) DescribeBuildRequest(input *DescribeBuildInput) (req *request // // Upload a Custom Server Build (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html) // -// # Related actions -// -// CreateBuild | ListBuilds | DescribeBuild | UpdateBuild | DeleteBuild | All -// APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3805,8 +3960,8 @@ func (c *GameLift) DescribeBuildRequest(input *DescribeBuildInput) (req *request // parameter values before retrying. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - InternalServiceException // The service encountered an unrecoverable internal failure while processing @@ -3835,6 +3990,100 @@ func (c *GameLift) DescribeBuildWithContext(ctx aws.Context, input *DescribeBuil return out, req.Send() } +const opDescribeCompute = "DescribeCompute" + +// DescribeComputeRequest generates a "aws/request.Request" representing the +// client's request for the DescribeCompute operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribeCompute for more information on using the DescribeCompute +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the DescribeComputeRequest method. +// req, resp := client.DescribeComputeRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeCompute +func (c *GameLift) DescribeComputeRequest(input *DescribeComputeInput) (req *request.Request, output *DescribeComputeOutput) { + op := &request.Operation{ + Name: opDescribeCompute, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DescribeComputeInput{} + } + + output = &DescribeComputeOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeCompute API operation for Amazon GameLift. +// +// Retrieves properties for a compute resource. To request a compute resource +// specify the fleet ID and compute name. If successful, GameLift returns an +// object containing the build properties. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon GameLift's +// API operation DescribeCompute for usage and error information. +// +// Returned Error Types: +// +// - UnauthorizedException +// The client failed authentication. Clients should not retry such requests. +// +// - InvalidRequestException +// One or more parameter values in the request are invalid. Correct the invalid +// parameter values before retrying. +// +// - NotFoundException +// THe requested resources was not found. The resource was either not created +// yet or deleted. +// +// - InternalServiceException +// The service encountered an unrecoverable internal failure while processing +// the request. Clients can retry such requests immediately or after a waiting +// period. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeCompute +func (c *GameLift) DescribeCompute(input *DescribeComputeInput) (*DescribeComputeOutput, error) { + req, out := c.DescribeComputeRequest(input) + return out, req.Send() +} + +// DescribeComputeWithContext is the same as DescribeCompute with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeCompute for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *GameLift) DescribeComputeWithContext(ctx aws.Context, input *DescribeComputeInput, opts ...request.Option) (*DescribeComputeOutput, error) { + req, out := c.DescribeComputeRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDescribeEC2InstanceLimits = "DescribeEC2InstanceLimits" // DescribeEC2InstanceLimitsRequest generates a "aws/request.Request" representing the @@ -3929,12 +4178,6 @@ func (c *GameLift) DescribeEC2InstanceLimitsRequest(input *DescribeEC2InstanceLi // // Setting up GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) // -// # Related actions -// -// CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits -// | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes -// | StopFleetActions | DeleteFleet | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -4054,13 +4297,6 @@ func (c *GameLift) DescribeFleetAttributesRequest(input *DescribeFleetAttributes // // Setting up GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) // -// # Related actions -// -// ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetCapacity -// | DescribeFleetEvents | DescribeFleetLocationAttributes | DescribeFleetPortSettings -// | DescribeFleetUtilization | DescribeRuntimeConfiguration | DescribeScalingPolicies -// | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -4076,8 +4312,8 @@ func (c *GameLift) DescribeFleetAttributesRequest(input *DescribeFleetAttributes // period. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - InvalidRequestException // One or more parameter values in the request are invalid. Correct the invalid @@ -4211,8 +4447,7 @@ func (c *GameLift) DescribeFleetCapacityRequest(input *DescribeFleetCapacityInpu // Retrieves the resource capacity settings for one or more fleets. The data // returned includes the current fleet capacity (number of EC2 instances), and // settings that can control how capacity scaling. For fleets with remote locations, -// this operation retrieves data for the fleet's home Region only. See DescribeFleetLocationCapacity -// to get capacity settings for a fleet's remote locations. +// this operation retrieves data for the fleet's home Region only. // // This operation can be used in the following ways: // @@ -4239,13 +4474,6 @@ func (c *GameLift) DescribeFleetCapacityRequest(input *DescribeFleetCapacityInpu // // GameLift metrics for fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet) // -// # Related actions -// -// ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetCapacity -// | DescribeFleetEvents | DescribeFleetLocationAttributes | DescribeFleetPortSettings -// | DescribeFleetUtilization | DescribeRuntimeConfiguration | DescribeScalingPolicies -// | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -4261,8 +4489,8 @@ func (c *GameLift) DescribeFleetCapacityRequest(input *DescribeFleetCapacityInpu // period. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - InvalidRequestException // One or more parameter values in the request are invalid. Correct the invalid @@ -4408,13 +4636,6 @@ func (c *GameLift) DescribeFleetEventsRequest(input *DescribeFleetEventsInput) ( // // Setting up GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) // -// # Related actions -// -// ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetCapacity -// | DescribeFleetEvents | DescribeFleetLocationAttributes | DescribeFleetPortSettings -// | DescribeFleetUtilization | DescribeRuntimeConfiguration | DescribeScalingPolicies -// | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -4425,8 +4646,8 @@ func (c *GameLift) DescribeFleetEventsRequest(input *DescribeFleetEventsInput) ( // Returned Error Types: // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - InternalServiceException // The service encountered an unrecoverable internal failure while processing @@ -4585,13 +4806,6 @@ func (c *GameLift) DescribeFleetLocationAttributesRequest(input *DescribeFleetLo // // Setting up GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) // -// # Related actions -// -// CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity -// | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity -// | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions | DeleteFleetLocations -// | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -4614,8 +4828,8 @@ func (c *GameLift) DescribeFleetLocationAttributesRequest(input *DescribeFleetLo // The client failed authentication. Clients should not retry such requests. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - UnsupportedRegionException // The requested operation is not supported in the Region specified. @@ -4753,13 +4967,6 @@ func (c *GameLift) DescribeFleetLocationCapacityRequest(input *DescribeFleetLoca // // GameLift metrics for fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet) // -// # Related actions -// -// CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity -// | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity -// | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions | DeleteFleetLocations -// | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -4782,8 +4989,8 @@ func (c *GameLift) DescribeFleetLocationCapacityRequest(input *DescribeFleetLoca // The client failed authentication. Clients should not retry such requests. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - UnsupportedRegionException // The requested operation is not supported in the Region specified. @@ -4870,13 +5077,6 @@ func (c *GameLift) DescribeFleetLocationUtilizationRequest(input *DescribeFleetL // // GameLift metrics for fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet) // -// # Related actions -// -// CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity -// | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity -// | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions | DeleteFleetLocations -// | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -4899,8 +5099,8 @@ func (c *GameLift) DescribeFleetLocationUtilizationRequest(input *DescribeFleetL // The client failed authentication. Clients should not retry such requests. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - UnsupportedRegionException // The requested operation is not supported in the Region specified. @@ -4992,13 +5192,6 @@ func (c *GameLift) DescribeFleetPortSettingsRequest(input *DescribeFleetPortSett // // Setting up GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) // -// # Related actions -// -// ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetCapacity -// | DescribeFleetEvents | DescribeFleetLocationAttributes | DescribeFleetPortSettings -// | DescribeFleetUtilization | DescribeRuntimeConfiguration | DescribeScalingPolicies -// | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -5014,8 +5207,8 @@ func (c *GameLift) DescribeFleetPortSettingsRequest(input *DescribeFleetPortSett // period. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - InvalidRequestException // One or more parameter values in the request are invalid. Correct the invalid @@ -5024,6 +5217,9 @@ func (c *GameLift) DescribeFleetPortSettingsRequest(input *DescribeFleetPortSett // - UnauthorizedException // The client failed authentication. Clients should not retry such requests. // +// - UnsupportedRegionException +// The requested operation is not supported in the Region specified. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeFleetPortSettings func (c *GameLift) DescribeFleetPortSettings(input *DescribeFleetPortSettingsInput) (*DescribeFleetPortSettingsOutput, error) { req, out := c.DescribeFleetPortSettingsRequest(input) @@ -5098,8 +5294,8 @@ func (c *GameLift) DescribeFleetUtilizationRequest(input *DescribeFleetUtilizati // Retrieves utilization statistics for one or more fleets. Utilization data // provides a snapshot of how the fleet's hosting resources are currently being // used. For fleets with remote locations, this operation retrieves data for -// the fleet's home Region only. See DescribeFleetLocationUtilization to get -// utilization statistics for a fleet's remote locations. +// the fleet's home Region only. See DescribeFleetLocationUtilization (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationUtilization.html) +// to get utilization statistics for a fleet's remote locations. // // This operation can be used in the following ways: // @@ -5111,9 +5307,10 @@ func (c *GameLift) DescribeFleetUtilizationRequest(input *DescribeFleetUtilizati // When requesting multiple fleets, use the pagination parameters to retrieve // results as a set of sequential pages. // -// If successful, a FleetUtilization object is returned for each requested fleet -// ID, unless the fleet identifier is not found. Each fleet utilization object -// includes a Location property, which is set to the fleet's home Region. +// If successful, a FleetUtilization (https://docs.aws.amazon.com/gamelift/latest/apireference/API_FleetUtilization.html) +// object is returned for each requested fleet ID, unless the fleet identifier +// is not found. Each fleet utilization object includes a Location property, +// which is set to the fleet's home Region. // // Some API operations may limit the number of fleet IDs allowed in one request. // If a request exceeds this limit, the request fails and the error message @@ -5125,13 +5322,6 @@ func (c *GameLift) DescribeFleetUtilizationRequest(input *DescribeFleetUtilizati // // GameLift Metrics for Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet) // -// # Related actions -// -// ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetCapacity -// | DescribeFleetEvents | DescribeFleetLocationAttributes | DescribeFleetPortSettings -// | DescribeFleetUtilization | DescribeRuntimeConfiguration | DescribeScalingPolicies -// | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -5147,8 +5337,8 @@ func (c *GameLift) DescribeFleetUtilizationRequest(input *DescribeFleetUtilizati // period. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - InvalidRequestException // One or more parameter values in the request are invalid. Correct the invalid @@ -5287,11 +5477,6 @@ func (c *GameLift) DescribeGameServerRequest(input *DescribeGameServerInput) (re // // GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) // -// # Related actions -// -// RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer -// | UpdateGameServer | DeregisterGameServer | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/reference-awssdk-fleetiq.html) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -5306,8 +5491,8 @@ func (c *GameLift) DescribeGameServerRequest(input *DescribeGameServerInput) (re // parameter values before retrying. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - UnauthorizedException // The client failed authentication. Clients should not retry such requests. @@ -5397,12 +5582,6 @@ func (c *GameLift) DescribeGameServerGroupRequest(input *DescribeGameServerGroup // // GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) // -// # Related actions -// -// CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup | -// UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup | SuspendGameServerGroup -// | DescribeGameServerInstances | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/reference-awssdk-fleetiq.html) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -5417,8 +5596,8 @@ func (c *GameLift) DescribeGameServerGroupRequest(input *DescribeGameServerGroup // parameter values before retrying. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - UnauthorizedException // The client failed authentication. Clients should not retry such requests. @@ -5504,9 +5683,7 @@ func (c *GameLift) DescribeGameServerInstancesRequest(input *DescribeGameServerI // // Retrieves status information about the Amazon EC2 instances associated with // a GameLift FleetIQ game server group. Use this operation to detect when instances -// are active or not available to host new game servers. If you are looking -// for instance configuration information, call DescribeGameServerGroup or access -// the corresponding Auto Scaling group properties. +// are active or not available to host new game servers. // // To request status for all instances in the game server group, provide a game // server group ID only. To request status for specific instances, provide the @@ -5523,12 +5700,6 @@ func (c *GameLift) DescribeGameServerInstancesRequest(input *DescribeGameServerI // // GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) // -// # Related actions -// -// CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup | -// UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup | SuspendGameServerGroup -// | DescribeGameServerInstances | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/reference-awssdk-fleetiq.html) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -5543,8 +5714,8 @@ func (c *GameLift) DescribeGameServerInstancesRequest(input *DescribeGameServerI // parameter values before retrying. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - UnauthorizedException // The client failed authentication. Clients should not retry such requests. @@ -5679,9 +5850,7 @@ func (c *GameLift) DescribeGameSessionDetailsRequest(input *DescribeGameSessionD // Retrieves additional game session properties, including the game session // protection policy in force, a set of one or more game sessions in a specific // fleet location. You can optionally filter the results by current game session -// status. Alternatively, use SearchGameSessions to request a set of active -// game sessions that are filtered by certain criteria. To retrieve all game -// session properties, use DescribeGameSessions. +// status. // // This operation can be used in the following ways: // @@ -5709,12 +5878,7 @@ func (c *GameLift) DescribeGameSessionDetailsRequest(input *DescribeGameSessionD // // Find a game session (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#gamelift-sdk-client-api-find) // -// # Related actions -// -// CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions -// | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | -// DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5731,8 +5895,8 @@ func (c *GameLift) DescribeGameSessionDetailsRequest(input *DescribeGameSessionD // period. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - InvalidRequestException // One or more parameter values in the request are invalid. Correct the invalid @@ -5879,15 +6043,6 @@ func (c *GameLift) DescribeGameSessionPlacementRequest(input *DescribeGameSessio // polling with DescribeGameSessionPlacement should only be used for games in // development with low game session usage. // -// If successful, a GameSessionPlacement object is returned. -// -// # Related actions -// -// CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions -// | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | -// DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -5907,8 +6062,8 @@ func (c *GameLift) DescribeGameSessionPlacementRequest(input *DescribeGameSessio // parameter values before retrying. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - UnauthorizedException // The client failed authentication. Clients should not retry such requests. @@ -5986,22 +6141,13 @@ func (c *GameLift) DescribeGameSessionQueuesRequest(input *DescribeGameSessionQu // // Retrieves the properties for one or more game session queues. When requesting // multiple queues, use the pagination parameters to retrieve results as a set -// of sequential pages. If successful, a GameSessionQueue object is returned -// for each requested queue. When specifying a list of queues, objects are returned +// of sequential pages. When specifying a list of queues, objects are returned // only for queues that currently exist in the Region. // // Learn more // // View Your Queues (https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-console.html) // -// # Related actions -// -// CreateGameSessionQueue (https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateGameSessionQueue.html) -// | DescribeGameSessionQueues (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionQueues.html) -// | UpdateGameSessionQueue (https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSessionQueue.html) -// | DeleteGameSessionQueue (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteGameSessionQueue.html) -// | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -6021,8 +6167,8 @@ func (c *GameLift) DescribeGameSessionQueuesRequest(input *DescribeGameSessionQu // parameter values before retrying. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - UnauthorizedException // The client failed authentication. Clients should not retry such requests. @@ -6150,17 +6296,7 @@ func (c *GameLift) DescribeGameSessionsRequest(input *DescribeGameSessionsInput) // DescribeGameSessions API operation for Amazon GameLift. // // Retrieves a set of one or more game sessions in a specific fleet location. -// You can optionally filter the results by current game session status. Alternatively, -// use SearchGameSessions to request a set of active game sessions that are -// filtered by certain criteria. To retrieve the protection policy for game -// sessions, use DescribeGameSessionDetails. -// -// This operation is not designed to be continually called to track game session -// status. This practice can cause you to exceed your API limit, which results -// in errors. Instead, you must configure configure an Amazon Simple Notification -// Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously -// polling with DescribeGameSessions should only be used for games in development -// with low game session usage. +// You can optionally filter the results by current game session status. // // This operation can be used in the following ways: // @@ -6184,12 +6320,12 @@ func (c *GameLift) DescribeGameSessionsRequest(input *DescribeGameSessionsInput) // If successful, a GameSession object is returned for each game session that // matches the request. // -// This operation is not designed to be continually called to track matchmaking -// ticket status. This practice can cause you to exceed your API limit, which -// results in errors. Instead, as a best practice, set up an Amazon Simple Notification -// Service to receive notifications, and provide the topic ARN in the matchmaking -// configuration. Continuously poling ticket status with DescribeGameSessions -// should only be used for games in development with low matchmaking usage. +// This operation is not designed to be continually called to track game session +// status. This practice can cause you to exceed your API limit, which results +// in errors. Instead, you must configure an Amazon Simple Notification Service +// (SNS) topic to receive notifications from FlexMatch or queues. Continuously +// polling with DescribeGameSessions should only be used for games in development +// with low game session usage. // // Available in Amazon GameLift Local. // @@ -6197,12 +6333,7 @@ func (c *GameLift) DescribeGameSessionsRequest(input *DescribeGameSessionsInput) // // Find a game session (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#gamelift-sdk-client-api-find) // -// # Related actions -// -// CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions -// | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | -// DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -6219,8 +6350,8 @@ func (c *GameLift) DescribeGameSessionsRequest(input *DescribeGameSessionsInput) // period. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - InvalidRequestException // One or more parameter values in the request are invalid. Correct the invalid @@ -6389,8 +6520,7 @@ func (c *GameLift) DescribeInstancesRequest(input *DescribeInstancesInput) (req // // # Related actions // -// DescribeInstances | GetInstanceAccess | DescribeEC2InstanceLimits | All APIs -// by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -6409,8 +6539,8 @@ func (c *GameLift) DescribeInstancesRequest(input *DescribeInstancesInput) (req // parameter values before retrying. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - InternalServiceException // The service encountered an unrecoverable internal failure while processing @@ -6548,8 +6678,7 @@ func (c *GameLift) DescribeMatchmakingRequest(input *DescribeMatchmakingInput) ( // ticket status. This practice can cause you to exceed your API limit, which // results in errors. Instead, as a best practice, set up an Amazon Simple Notification // Service to receive notifications, and provide the topic ARN in the matchmaking -// configuration. Continuously polling ticket status with DescribeMatchmaking -// should only be used for games in development with low matchmaking usage. +// configuration. // // Learn more // @@ -6557,11 +6686,6 @@ func (c *GameLift) DescribeMatchmakingRequest(input *DescribeMatchmakingInput) ( // // Set Up FlexMatch event notification (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html) // -// # Related actions -// -// StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch | -// StartMatchBackfill | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -6670,13 +6794,6 @@ func (c *GameLift) DescribeMatchmakingConfigurationsRequest(input *DescribeMatch // // Setting up FlexMatch matchmakers (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/matchmaker-build.html) // -// # Related actions -// -// CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations | UpdateMatchmakingConfiguration -// | DeleteMatchmakingConfiguration | CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets -// | ValidateMatchmakingRuleSet | DeleteMatchmakingRuleSet | All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -6830,13 +6947,6 @@ func (c *GameLift) DescribeMatchmakingRuleSetsRequest(input *DescribeMatchmaking // // - Build a rule set (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html) // -// # Related actions -// -// CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations | UpdateMatchmakingConfiguration -// | DeleteMatchmakingConfiguration | CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets -// | ValidateMatchmakingRuleSet | DeleteMatchmakingRuleSet | All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -6856,8 +6966,8 @@ func (c *GameLift) DescribeMatchmakingRuleSetsRequest(input *DescribeMatchmaking // period. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - UnsupportedRegionException // The requested operation is not supported in the Region specified. @@ -7004,12 +7114,9 @@ func (c *GameLift) DescribePlayerSessionsRequest(input *DescribePlayerSessionsIn // If successful, a PlayerSession object is returned for each session that matches // the request. // -// Available in Amazon GameLift Local. -// // # Related actions // -// CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions | StartGameSessionPlacement -// | DescribeGameSessionPlacement | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -7026,8 +7133,8 @@ func (c *GameLift) DescribePlayerSessionsRequest(input *DescribePlayerSessionsIn // period. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - InvalidRequestException // One or more parameter values in the request are invalid. Correct the invalid @@ -7168,13 +7275,6 @@ func (c *GameLift) DescribeRuntimeConfigurationRequest(input *DescribeRuntimeCon // // Running multiple processes on a fleet (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-multiprocess.html) // -// # Related actions -// -// ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetCapacity -// | DescribeFleetEvents | DescribeFleetLocationAttributes | DescribeFleetPortSettings -// | DescribeFleetUtilization | DescribeRuntimeConfiguration | DescribeScalingPolicies -// | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -7188,8 +7288,8 @@ func (c *GameLift) DescribeRuntimeConfigurationRequest(input *DescribeRuntimeCon // The client failed authentication. Clients should not retry such requests. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - InternalServiceException // The service encountered an unrecoverable internal failure while processing @@ -7278,16 +7378,8 @@ func (c *GameLift) DescribeScalingPoliciesRequest(input *DescribeScalingPolicies // Use the pagination parameters to retrieve results as a set of sequential // pages. If successful, set of ScalingPolicy objects is returned for the fleet. // -// A fleet may have all of its scaling policies suspended (StopFleetActions). -// This operation does not affect the status of the scaling policies, which -// remains ACTIVE. To see whether a fleet's scaling policies are in force or -// suspended, call DescribeFleetAttributes and check the stopped actions. -// -// # Related actions -// -// DescribeFleetCapacity | UpdateFleetCapacity | DescribeEC2InstanceLimits | -// PutScalingPolicy | DescribeScalingPolicies | DeleteScalingPolicy | StopFleetActions -// | StartFleetActions | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// A fleet may have all of its scaling policies suspended. This operation does +// not affect the status of the scaling policies, which remains ACTIVE. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -7311,8 +7403,8 @@ func (c *GameLift) DescribeScalingPoliciesRequest(input *DescribeScalingPolicies // The client failed authentication. Clients should not retry such requests. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - UnsupportedRegionException // The requested operation is not supported in the Region specified. @@ -7444,8 +7536,7 @@ func (c *GameLift) DescribeScriptRequest(input *DescribeScriptInput) (req *reque // // # Related actions // -// CreateScript | ListScripts | DescribeScript | UpdateScript | DeleteScript -// | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -7469,8 +7560,8 @@ func (c *GameLift) DescribeScriptRequest(input *DescribeScriptInput) (req *reque // period. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeScript func (c *GameLift) DescribeScript(input *DescribeScriptInput) (*DescribeScriptOutput, error) { @@ -7544,9 +7635,7 @@ func (c *GameLift) DescribeVpcPeeringAuthorizationsRequest(input *DescribeVpcPee // // # Related actions // -// CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | DeleteVpcPeeringAuthorization -// | CreateVpcPeeringConnection | DescribeVpcPeeringConnections | DeleteVpcPeeringConnection -// | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -7646,9 +7735,7 @@ func (c *GameLift) DescribeVpcPeeringConnectionsRequest(input *DescribeVpcPeerin // // # Related actions // -// CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | DeleteVpcPeeringAuthorization -// | CreateVpcPeeringConnection | DescribeVpcPeeringConnections | DeleteVpcPeeringConnection -// | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -7667,8 +7754,8 @@ func (c *GameLift) DescribeVpcPeeringConnectionsRequest(input *DescribeVpcPeerin // parameter values before retrying. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - InternalServiceException // The service encountered an unrecoverable internal failure while processing @@ -7697,6 +7784,212 @@ func (c *GameLift) DescribeVpcPeeringConnectionsWithContext(ctx aws.Context, inp return out, req.Send() } +const opGetComputeAccess = "GetComputeAccess" + +// GetComputeAccessRequest generates a "aws/request.Request" representing the +// client's request for the GetComputeAccess operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetComputeAccess for more information on using the GetComputeAccess +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the GetComputeAccessRequest method. +// req, resp := client.GetComputeAccessRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/GetComputeAccess +func (c *GameLift) GetComputeAccessRequest(input *GetComputeAccessInput) (req *request.Request, output *GetComputeAccessOutput) { + op := &request.Operation{ + Name: opGetComputeAccess, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &GetComputeAccessInput{} + } + + output = &GetComputeAccessOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetComputeAccess API operation for Amazon GameLift. +// +// Requests remote access to a fleet instance. Remote access is useful for debugging, +// gathering benchmarking data, or observing activity in real time. +// +// To remotely access an instance, you need credentials that match the operating +// system of the instance. For a Windows instance, GameLift returns a user name +// and password as strings for use with a Windows Remote Desktop client. For +// a Linux instance, GameLift returns a user name and RSA private key, also +// as strings, for use with an SSH client. The private key must be saved in +// the proper format to a .pem file before using. If you're making this request +// using the CLI, saving the secret can be handled as part of the GetInstanceAccess +// request, as shown in one of the examples for this operation. +// +// To request access to a specific instance, specify the IDs of both the instance +// and the fleet it belongs to. +// +// # Learn more +// +// Remotely Access Fleet Instances (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-remote-access.html) +// +// Debug Fleet Issues (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html) +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon GameLift's +// API operation GetComputeAccess for usage and error information. +// +// Returned Error Types: +// +// - UnauthorizedException +// The client failed authentication. Clients should not retry such requests. +// +// - InvalidRequestException +// One or more parameter values in the request are invalid. Correct the invalid +// parameter values before retrying. +// +// - NotFoundException +// THe requested resources was not found. The resource was either not created +// yet or deleted. +// +// - InternalServiceException +// The service encountered an unrecoverable internal failure while processing +// the request. Clients can retry such requests immediately or after a waiting +// period. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/GetComputeAccess +func (c *GameLift) GetComputeAccess(input *GetComputeAccessInput) (*GetComputeAccessOutput, error) { + req, out := c.GetComputeAccessRequest(input) + return out, req.Send() +} + +// GetComputeAccessWithContext is the same as GetComputeAccess with the addition of +// the ability to pass a context and additional request options. +// +// See GetComputeAccess for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *GameLift) GetComputeAccessWithContext(ctx aws.Context, input *GetComputeAccessInput, opts ...request.Option) (*GetComputeAccessOutput, error) { + req, out := c.GetComputeAccessRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opGetComputeAuthToken = "GetComputeAuthToken" + +// GetComputeAuthTokenRequest generates a "aws/request.Request" representing the +// client's request for the GetComputeAuthToken operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetComputeAuthToken for more information on using the GetComputeAuthToken +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the GetComputeAuthTokenRequest method. +// req, resp := client.GetComputeAuthTokenRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/GetComputeAuthToken +func (c *GameLift) GetComputeAuthTokenRequest(input *GetComputeAuthTokenInput) (req *request.Request, output *GetComputeAuthTokenOutput) { + op := &request.Operation{ + Name: opGetComputeAuthToken, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &GetComputeAuthTokenInput{} + } + + output = &GetComputeAuthTokenOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetComputeAuthToken API operation for Amazon GameLift. +// +// Requests an authorization token from GameLift. The authorization token is +// used by your game server to authenticate with GameLift. Each authentication +// token has an expiration token. To continue using the compute resource to +// host your game server, regularly retrieve a new authorization token. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon GameLift's +// API operation GetComputeAuthToken for usage and error information. +// +// Returned Error Types: +// +// - UnauthorizedException +// The client failed authentication. Clients should not retry such requests. +// +// - InvalidRequestException +// One or more parameter values in the request are invalid. Correct the invalid +// parameter values before retrying. +// +// - NotFoundException +// THe requested resources was not found. The resource was either not created +// yet or deleted. +// +// - InternalServiceException +// The service encountered an unrecoverable internal failure while processing +// the request. Clients can retry such requests immediately or after a waiting +// period. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/GetComputeAuthToken +func (c *GameLift) GetComputeAuthToken(input *GetComputeAuthTokenInput) (*GetComputeAuthTokenOutput, error) { + req, out := c.GetComputeAuthTokenRequest(input) + return out, req.Send() +} + +// GetComputeAuthTokenWithContext is the same as GetComputeAuthToken with the addition of +// the ability to pass a context and additional request options. +// +// See GetComputeAuthToken for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *GameLift) GetComputeAuthTokenWithContext(ctx aws.Context, input *GetComputeAuthTokenInput, opts ...request.Option) (*GetComputeAuthTokenOutput, error) { + req, out := c.GetComputeAuthTokenRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opGetGameSessionLogUrl = "GetGameSessionLogUrl" // GetGameSessionLogUrlRequest generates a "aws/request.Request" representing the @@ -7748,12 +8041,7 @@ func (c *GameLift) GetGameSessionLogUrlRequest(input *GetGameSessionLogUrlInput) // page for maximum log file sizes. Log files that exceed this limit are not // saved. // -// # Related actions -// -// CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions -// | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | -// DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -7770,8 +8058,8 @@ func (c *GameLift) GetGameSessionLogUrlRequest(input *GetGameSessionLogUrlInput) // period. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - UnauthorizedException // The client failed authentication. Clients should not retry such requests. @@ -7859,8 +8147,7 @@ func (c *GameLift) GetInstanceAccessRequest(input *GetInstanceAccessInput) (req // // To request access to a specific instance, specify the IDs of both the instance // and the fleet it belongs to. You can retrieve a fleet's instance IDs by calling -// DescribeInstances. If successful, an InstanceAccess object is returned that -// contains the instance's IP address and a set of credentials. +// DescribeInstances (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeInstances.html). // // # Learn more // @@ -7870,8 +8157,7 @@ func (c *GameLift) GetInstanceAccessRequest(input *GetInstanceAccessInput) (req // // # Related actions // -// DescribeInstances | GetInstanceAccess | DescribeEC2InstanceLimits | All APIs -// by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -7890,8 +8176,8 @@ func (c *GameLift) GetInstanceAccessRequest(input *GetInstanceAccessInput) (req // parameter values before retrying. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - InternalServiceException // The service encountered an unrecoverable internal failure while processing @@ -7977,8 +8263,7 @@ func (c *GameLift) ListAliasesRequest(input *ListAliasesInput) (req *request.Req // // # Related actions // -// CreateAlias | ListAliases | DescribeAlias | UpdateAlias | DeleteAlias | ResolveAlias -// | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -8134,10 +8419,7 @@ func (c *GameLift) ListBuildsRequest(input *ListBuildsInput) (req *request.Reque // // Upload a Custom Server Build (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html) // -// # Related actions -// -// CreateBuild | ListBuilds | DescribeBuild | UpdateBuild | DeleteBuild | All -// APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -8233,6 +8515,152 @@ func (c *GameLift) ListBuildsPagesWithContext(ctx aws.Context, input *ListBuilds return p.Err() } +const opListCompute = "ListCompute" + +// ListComputeRequest generates a "aws/request.Request" representing the +// client's request for the ListCompute operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListCompute for more information on using the ListCompute +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the ListComputeRequest method. +// req, resp := client.ListComputeRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListCompute +func (c *GameLift) ListComputeRequest(input *ListComputeInput) (req *request.Request, output *ListComputeOutput) { + op := &request.Operation{ + Name: opListCompute, + HTTPMethod: "POST", + HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "Limit", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListComputeInput{} + } + + output = &ListComputeOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListCompute API operation for Amazon GameLift. +// +// Retrieves all compute resources registered to a fleet in your Amazon Web +// Services account. You can filter the result set by location. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon GameLift's +// API operation ListCompute for usage and error information. +// +// Returned Error Types: +// +// - UnauthorizedException +// The client failed authentication. Clients should not retry such requests. +// +// - InvalidRequestException +// One or more parameter values in the request are invalid. Correct the invalid +// parameter values before retrying. +// +// - InternalServiceException +// The service encountered an unrecoverable internal failure while processing +// the request. Clients can retry such requests immediately or after a waiting +// period. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListCompute +func (c *GameLift) ListCompute(input *ListComputeInput) (*ListComputeOutput, error) { + req, out := c.ListComputeRequest(input) + return out, req.Send() +} + +// ListComputeWithContext is the same as ListCompute with the addition of +// the ability to pass a context and additional request options. +// +// See ListCompute for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *GameLift) ListComputeWithContext(ctx aws.Context, input *ListComputeInput, opts ...request.Option) (*ListComputeOutput, error) { + req, out := c.ListComputeRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListComputePages iterates over the pages of a ListCompute operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListCompute method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListCompute operation. +// pageNum := 0 +// err := client.ListComputePages(params, +// func(page *gamelift.ListComputeOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +func (c *GameLift) ListComputePages(input *ListComputeInput, fn func(*ListComputeOutput, bool) bool) error { + return c.ListComputePagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListComputePagesWithContext same as ListComputePages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *GameLift) ListComputePagesWithContext(ctx aws.Context, input *ListComputeInput, fn func(*ListComputeOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListComputeInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListComputeRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListComputeOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opListFleets = "ListFleets" // ListFleetsRequest generates a "aws/request.Request" representing the @@ -8314,12 +8742,6 @@ func (c *GameLift) ListFleetsRequest(input *ListFleetsInput) (req *request.Reque // // Setting up GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) // -// # Related actions -// -// CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits -// | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes -// | StopFleetActions | DeleteFleet | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -8335,8 +8757,8 @@ func (c *GameLift) ListFleetsRequest(input *ListFleetsInput) (req *request.Reque // period. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - InvalidRequestException // One or more parameter values in the request are invalid. Correct the invalid @@ -8467,29 +8889,169 @@ func (c *GameLift) ListGameServerGroupsRequest(input *ListGameServerGroupsInput) // ListGameServerGroups API operation for Amazon GameLift. // +// Lists a game server groups. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon GameLift's +// API operation ListGameServerGroups for usage and error information. +// +// Returned Error Types: +// +// - InvalidRequestException +// One or more parameter values in the request are invalid. Correct the invalid +// parameter values before retrying. +// +// - UnauthorizedException +// The client failed authentication. Clients should not retry such requests. +// +// - InternalServiceException +// The service encountered an unrecoverable internal failure while processing +// the request. Clients can retry such requests immediately or after a waiting +// period. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListGameServerGroups +func (c *GameLift) ListGameServerGroups(input *ListGameServerGroupsInput) (*ListGameServerGroupsOutput, error) { + req, out := c.ListGameServerGroupsRequest(input) + return out, req.Send() +} + +// ListGameServerGroupsWithContext is the same as ListGameServerGroups with the addition of +// the ability to pass a context and additional request options. +// +// See ListGameServerGroups for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *GameLift) ListGameServerGroupsWithContext(ctx aws.Context, input *ListGameServerGroupsInput, opts ...request.Option) (*ListGameServerGroupsOutput, error) { + req, out := c.ListGameServerGroupsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListGameServerGroupsPages iterates over the pages of a ListGameServerGroups operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListGameServerGroups method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListGameServerGroups operation. +// pageNum := 0 +// err := client.ListGameServerGroupsPages(params, +// func(page *gamelift.ListGameServerGroupsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +func (c *GameLift) ListGameServerGroupsPages(input *ListGameServerGroupsInput, fn func(*ListGameServerGroupsOutput, bool) bool) error { + return c.ListGameServerGroupsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListGameServerGroupsPagesWithContext same as ListGameServerGroupsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *GameLift) ListGameServerGroupsPagesWithContext(ctx aws.Context, input *ListGameServerGroupsInput, fn func(*ListGameServerGroupsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListGameServerGroupsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListGameServerGroupsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListGameServerGroupsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListGameServers = "ListGameServers" + +// ListGameServersRequest generates a "aws/request.Request" representing the +// client's request for the ListGameServers operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListGameServers for more information on using the ListGameServers +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the ListGameServersRequest method. +// req, resp := client.ListGameServersRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListGameServers +func (c *GameLift) ListGameServersRequest(input *ListGameServersInput) (req *request.Request, output *ListGameServersOutput) { + op := &request.Operation{ + Name: opListGameServers, + HTTPMethod: "POST", + HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "Limit", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListGameServersInput{} + } + + output = &ListGameServersOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListGameServers API operation for Amazon GameLift. +// // This operation is used with the GameLift FleetIQ solution and game server // groups. // -// Retrieves information on all game servers groups that exist in the current -// Amazon Web Services account for the selected Region. Use the pagination parameters -// to retrieve results in a set of sequential segments. +// Retrieves information on all game servers that are currently active in a +// specified game server group. You can opt to sort the list by game server +// age. Use the pagination parameters to retrieve results in a set of sequential +// segments. // // # Learn more // // GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) // -// # Related actions -// -// CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup | -// UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup | SuspendGameServerGroup -// | DescribeGameServerInstances | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/reference-awssdk-fleetiq.html) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for Amazon GameLift's -// API operation ListGameServerGroups for usage and error information. +// API operation ListGameServers for usage and error information. // // Returned Error Types: // @@ -8505,64 +9067,64 @@ func (c *GameLift) ListGameServerGroupsRequest(input *ListGameServerGroupsInput) // the request. Clients can retry such requests immediately or after a waiting // period. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListGameServerGroups -func (c *GameLift) ListGameServerGroups(input *ListGameServerGroupsInput) (*ListGameServerGroupsOutput, error) { - req, out := c.ListGameServerGroupsRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListGameServers +func (c *GameLift) ListGameServers(input *ListGameServersInput) (*ListGameServersOutput, error) { + req, out := c.ListGameServersRequest(input) return out, req.Send() } -// ListGameServerGroupsWithContext is the same as ListGameServerGroups with the addition of +// ListGameServersWithContext is the same as ListGameServers with the addition of // the ability to pass a context and additional request options. // -// See ListGameServerGroups for details on how to use this API operation. +// See ListGameServers for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *GameLift) ListGameServerGroupsWithContext(ctx aws.Context, input *ListGameServerGroupsInput, opts ...request.Option) (*ListGameServerGroupsOutput, error) { - req, out := c.ListGameServerGroupsRequest(input) +func (c *GameLift) ListGameServersWithContext(ctx aws.Context, input *ListGameServersInput, opts ...request.Option) (*ListGameServersOutput, error) { + req, out := c.ListGameServersRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// ListGameServerGroupsPages iterates over the pages of a ListGameServerGroups operation, +// ListGameServersPages iterates over the pages of a ListGameServers operation, // calling the "fn" function with the response data for each page. To stop // iterating, return false from the fn function. // -// See ListGameServerGroups method for more information on how to use this operation. +// See ListGameServers method for more information on how to use this operation. // // Note: This operation can generate multiple requests to a service. // -// // Example iterating over at most 3 pages of a ListGameServerGroups operation. +// // Example iterating over at most 3 pages of a ListGameServers operation. // pageNum := 0 -// err := client.ListGameServerGroupsPages(params, -// func(page *gamelift.ListGameServerGroupsOutput, lastPage bool) bool { +// err := client.ListGameServersPages(params, +// func(page *gamelift.ListGameServersOutput, lastPage bool) bool { // pageNum++ // fmt.Println(page) // return pageNum <= 3 // }) -func (c *GameLift) ListGameServerGroupsPages(input *ListGameServerGroupsInput, fn func(*ListGameServerGroupsOutput, bool) bool) error { - return c.ListGameServerGroupsPagesWithContext(aws.BackgroundContext(), input, fn) +func (c *GameLift) ListGameServersPages(input *ListGameServersInput, fn func(*ListGameServersOutput, bool) bool) error { + return c.ListGameServersPagesWithContext(aws.BackgroundContext(), input, fn) } -// ListGameServerGroupsPagesWithContext same as ListGameServerGroupsPages except +// ListGameServersPagesWithContext same as ListGameServersPages except // it takes a Context and allows setting request options on the pages. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *GameLift) ListGameServerGroupsPagesWithContext(ctx aws.Context, input *ListGameServerGroupsInput, fn func(*ListGameServerGroupsOutput, bool) bool, opts ...request.Option) error { +func (c *GameLift) ListGameServersPagesWithContext(ctx aws.Context, input *ListGameServersInput, fn func(*ListGameServersOutput, bool) bool, opts ...request.Option) error { p := request.Pagination{ NewRequest: func() (*request.Request, error) { - var inCpy *ListGameServerGroupsInput + var inCpy *ListGameServersInput if input != nil { tmp := *input inCpy = &tmp } - req, _ := c.ListGameServerGroupsRequest(inCpy) + req, _ := c.ListGameServersRequest(inCpy) req.SetContext(ctx) req.ApplyOptions(opts...) return req, nil @@ -8570,7 +9132,7 @@ func (c *GameLift) ListGameServerGroupsPagesWithContext(ctx aws.Context, input * } for p.Next() { - if !fn(p.Page().(*ListGameServerGroupsOutput), !p.HasNextPage()) { + if !fn(p.Page().(*ListGameServersOutput), !p.HasNextPage()) { break } } @@ -8578,34 +9140,34 @@ func (c *GameLift) ListGameServerGroupsPagesWithContext(ctx aws.Context, input * return p.Err() } -const opListGameServers = "ListGameServers" +const opListLocations = "ListLocations" -// ListGameServersRequest generates a "aws/request.Request" representing the -// client's request for the ListGameServers operation. The "output" return +// ListLocationsRequest generates a "aws/request.Request" representing the +// client's request for the ListLocations operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See ListGameServers for more information on using the ListGameServers +// See ListLocations for more information on using the ListLocations // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // -// // Example sending a request using the ListGameServersRequest method. -// req, resp := client.ListGameServersRequest(params) +// // Example sending a request using the ListLocationsRequest method. +// req, resp := client.ListLocationsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListGameServers -func (c *GameLift) ListGameServersRequest(input *ListGameServersInput) (req *request.Request, output *ListGameServersOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListLocations +func (c *GameLift) ListLocationsRequest(input *ListLocationsInput) (req *request.Request, output *ListLocationsOutput) { op := &request.Operation{ - Name: opListGameServers, + Name: opListLocations, HTTPMethod: "POST", HTTPPath: "/", Paginator: &request.Paginator{ @@ -8617,112 +9179,97 @@ func (c *GameLift) ListGameServersRequest(input *ListGameServersInput) (req *req } if input == nil { - input = &ListGameServersInput{} + input = &ListLocationsInput{} } - output = &ListGameServersOutput{} + output = &ListLocationsOutput{} req = c.newRequest(op, input, output) return } -// ListGameServers API operation for Amazon GameLift. -// -// This operation is used with the GameLift FleetIQ solution and game server -// groups. -// -// Retrieves information on all game servers that are currently active in a -// specified game server group. You can opt to sort the list by game server -// age. Use the pagination parameters to retrieve results in a set of sequential -// segments. -// -// # Learn more -// -// GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) -// -// # Related actions +// ListLocations API operation for Amazon GameLift. // -// RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer -// | UpdateGameServer | DeregisterGameServer | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/reference-awssdk-fleetiq.html) +// Lists all custom and Amazon Web Services locations. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for Amazon GameLift's -// API operation ListGameServers for usage and error information. +// API operation ListLocations for usage and error information. // // Returned Error Types: // +// - UnauthorizedException +// The client failed authentication. Clients should not retry such requests. +// // - InvalidRequestException // One or more parameter values in the request are invalid. Correct the invalid // parameter values before retrying. // -// - UnauthorizedException -// The client failed authentication. Clients should not retry such requests. -// // - InternalServiceException // The service encountered an unrecoverable internal failure while processing // the request. Clients can retry such requests immediately or after a waiting // period. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListGameServers -func (c *GameLift) ListGameServers(input *ListGameServersInput) (*ListGameServersOutput, error) { - req, out := c.ListGameServersRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListLocations +func (c *GameLift) ListLocations(input *ListLocationsInput) (*ListLocationsOutput, error) { + req, out := c.ListLocationsRequest(input) return out, req.Send() } -// ListGameServersWithContext is the same as ListGameServers with the addition of +// ListLocationsWithContext is the same as ListLocations with the addition of // the ability to pass a context and additional request options. // -// See ListGameServers for details on how to use this API operation. +// See ListLocations for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *GameLift) ListGameServersWithContext(ctx aws.Context, input *ListGameServersInput, opts ...request.Option) (*ListGameServersOutput, error) { - req, out := c.ListGameServersRequest(input) +func (c *GameLift) ListLocationsWithContext(ctx aws.Context, input *ListLocationsInput, opts ...request.Option) (*ListLocationsOutput, error) { + req, out := c.ListLocationsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// ListGameServersPages iterates over the pages of a ListGameServers operation, +// ListLocationsPages iterates over the pages of a ListLocations operation, // calling the "fn" function with the response data for each page. To stop // iterating, return false from the fn function. // -// See ListGameServers method for more information on how to use this operation. +// See ListLocations method for more information on how to use this operation. // // Note: This operation can generate multiple requests to a service. // -// // Example iterating over at most 3 pages of a ListGameServers operation. +// // Example iterating over at most 3 pages of a ListLocations operation. // pageNum := 0 -// err := client.ListGameServersPages(params, -// func(page *gamelift.ListGameServersOutput, lastPage bool) bool { +// err := client.ListLocationsPages(params, +// func(page *gamelift.ListLocationsOutput, lastPage bool) bool { // pageNum++ // fmt.Println(page) // return pageNum <= 3 // }) -func (c *GameLift) ListGameServersPages(input *ListGameServersInput, fn func(*ListGameServersOutput, bool) bool) error { - return c.ListGameServersPagesWithContext(aws.BackgroundContext(), input, fn) +func (c *GameLift) ListLocationsPages(input *ListLocationsInput, fn func(*ListLocationsOutput, bool) bool) error { + return c.ListLocationsPagesWithContext(aws.BackgroundContext(), input, fn) } -// ListGameServersPagesWithContext same as ListGameServersPages except +// ListLocationsPagesWithContext same as ListLocationsPages except // it takes a Context and allows setting request options on the pages. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *GameLift) ListGameServersPagesWithContext(ctx aws.Context, input *ListGameServersInput, fn func(*ListGameServersOutput, bool) bool, opts ...request.Option) error { +func (c *GameLift) ListLocationsPagesWithContext(ctx aws.Context, input *ListLocationsInput, fn func(*ListLocationsOutput, bool) bool, opts ...request.Option) error { p := request.Pagination{ NewRequest: func() (*request.Request, error) { - var inCpy *ListGameServersInput + var inCpy *ListLocationsInput if input != nil { tmp := *input inCpy = &tmp } - req, _ := c.ListGameServersRequest(inCpy) + req, _ := c.ListLocationsRequest(inCpy) req.SetContext(ctx) req.ApplyOptions(opts...) return req, nil @@ -8730,7 +9277,7 @@ func (c *GameLift) ListGameServersPagesWithContext(ctx aws.Context, input *ListG } for p.Next() { - if !fn(p.Page().(*ListGameServersOutput), !p.HasNextPage()) { + if !fn(p.Page().(*ListLocationsOutput), !p.HasNextPage()) { break } } @@ -8796,8 +9343,7 @@ func (c *GameLift) ListScriptsRequest(input *ListScriptsInput) (req *request.Req // // # Related actions // -// CreateScript | ListScripts | DescribeScript | UpdateScript | DeleteScript -// | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -8966,7 +9512,7 @@ func (c *GameLift) ListTagsForResourceRequest(input *ListTagsForResourceInput) ( // // # Related actions // -// TagResource | UntagResource | ListTagsForResource | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -8978,8 +9524,8 @@ func (c *GameLift) ListTagsForResourceRequest(input *ListTagsForResourceInput) ( // Returned Error Types: // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - InvalidRequestException // One or more parameter values in the request are invalid. Correct the invalid @@ -9074,11 +9620,6 @@ func (c *GameLift) PutScalingPolicyRequest(input *PutScalingPolicyInput) (req *r // policies, or both. We recommend caution, however, because multiple auto-scaling // policies can have unintended consequences. // -// You can temporarily suspend all scaling policies for a fleet by calling StopFleetActions -// with the fleet action AUTO_SCALING. To resume scaling policies, call StartFleetActions -// with the same fleet action. To stop just one scaling policy--or to permanently -// remove it, you must delete the policy with DeleteScalingPolicy. -// // Learn more about how to work with auto-scaling in Set Up Fleet Automatic // Scaling (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-autoscaling.html). // @@ -9135,12 +9676,6 @@ func (c *GameLift) PutScalingPolicyRequest(input *PutScalingPolicyInput) (req *r // successfully created. If the fleet's auto-scaling actions are temporarily // suspended, the new policy will be in force once the fleet actions are restarted. // -// # Related actions -// -// DescribeFleetCapacity | UpdateFleetCapacity | DescribeEC2InstanceLimits | -// PutScalingPolicy | DescribeScalingPolicies | DeleteScalingPolicy | StopFleetActions -// | StartFleetActions | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -9163,8 +9698,8 @@ func (c *GameLift) PutScalingPolicyRequest(input *PutScalingPolicyInput) (req *r // The client failed authentication. Clients should not retry such requests. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/PutScalingPolicy func (c *GameLift) PutScalingPolicy(input *PutScalingPolicyInput) (*PutScalingPolicyOutput, error) { @@ -9188,6 +9723,108 @@ func (c *GameLift) PutScalingPolicyWithContext(ctx aws.Context, input *PutScalin return out, req.Send() } +const opRegisterCompute = "RegisterCompute" + +// RegisterComputeRequest generates a "aws/request.Request" representing the +// client's request for the RegisterCompute operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See RegisterCompute for more information on using the RegisterCompute +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the RegisterComputeRequest method. +// req, resp := client.RegisterComputeRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/RegisterCompute +func (c *GameLift) RegisterComputeRequest(input *RegisterComputeInput) (req *request.Request, output *RegisterComputeOutput) { + op := &request.Operation{ + Name: opRegisterCompute, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &RegisterComputeInput{} + } + + output = &RegisterComputeOutput{} + req = c.newRequest(op, input, output) + return +} + +// RegisterCompute API operation for Amazon GameLift. +// +// Registers your compute resources in a fleet you previously created. After +// you register a compute to your fleet, you can monitor and manage your compute +// using GameLift. The operation returns the compute resource containing SDK +// endpoint you can use to connect your game server to GameLift. +// +// Learn more +// +// - Create an Anywhere fleet (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-anywhere.html) +// +// - Test your integration (https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-testing.html) +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon GameLift's +// API operation RegisterCompute for usage and error information. +// +// Returned Error Types: +// +// - UnauthorizedException +// The client failed authentication. Clients should not retry such requests. +// +// - InvalidRequestException +// One or more parameter values in the request are invalid. Correct the invalid +// parameter values before retrying. +// +// - ConflictException +// The requested operation would cause a conflict with the current state of +// a service resource associated with the request. Resolve the conflict before +// retrying this request. +// +// - InternalServiceException +// The service encountered an unrecoverable internal failure while processing +// the request. Clients can retry such requests immediately or after a waiting +// period. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/RegisterCompute +func (c *GameLift) RegisterCompute(input *RegisterComputeInput) (*RegisterComputeOutput, error) { + req, out := c.RegisterComputeRequest(input) + return out, req.Send() +} + +// RegisterComputeWithContext is the same as RegisterCompute with the addition of +// the ability to pass a context and additional request options. +// +// See RegisterCompute for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *GameLift) RegisterComputeWithContext(ctx aws.Context, input *RegisterComputeInput, opts ...request.Option) (*RegisterComputeOutput, error) { + req, out := c.RegisterComputeRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opRegisterGameServer = "RegisterGameServer" // RegisterGameServerRequest generates a "aws/request.Request" representing the @@ -9243,9 +9880,7 @@ func (c *GameLift) RegisterGameServerRequest(input *RegisterGameServerInput) (re // // To register a game server, identify the game server group and instance where // the game server is running, and provide a unique identifier for the game -// server. You can also include connection and game server data. When a game -// client or service requests a game server by calling ClaimGameServer, this -// information is returned in the response. +// server. You can also include connection and game server data. // // Once a game server is successfully registered, it is put in status AVAILABLE. // A request to register a game server may fail if the instance it is running @@ -9256,11 +9891,6 @@ func (c *GameLift) RegisterGameServerRequest(input *RegisterGameServerInput) (re // // GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) // -// # Related actions -// -// RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer -// | UpdateGameServer | DeregisterGameServer | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/reference-awssdk-fleetiq.html) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -9282,15 +9912,15 @@ func (c *GameLift) RegisterGameServerRequest(input *RegisterGameServerInput) (re // - UnauthorizedException // The client failed authentication. Clients should not retry such requests. // +// - LimitExceededException +// The requested operation would cause the resource to exceed the allowed service +// limit. Resolve the issue before retrying. +// // - InternalServiceException // The service encountered an unrecoverable internal failure while processing // the request. Clients can retry such requests immediately or after a waiting // period. // -// - LimitExceededException -// The requested operation would cause the resource to exceed the allowed service -// limit. Resolve the issue before retrying. -// // See also, https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/RegisterGameServer func (c *GameLift) RegisterGameServer(input *RegisterGameServerInput) (*RegisterGameServerOutput, error) { req, out := c.RegisterGameServerRequest(input) @@ -9358,7 +9988,7 @@ func (c *GameLift) RequestUploadCredentialsRequest(input *RequestUploadCredentia // // Retrieves a fresh set of credentials for use when uploading a new set of // game build files to Amazon GameLift's Amazon S3. This is done as part of -// the build creation process; see CreateBuild. +// the build creation process; see GameSession (https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateBuild.html). // // To request new credentials, specify the build ID as returned with an initial // CreateBuild request. If successful, a new set of credentials are returned, @@ -9368,10 +9998,7 @@ func (c *GameLift) RequestUploadCredentialsRequest(input *RequestUploadCredentia // // Create a Build with Files in S3 (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html#gamelift-build-cli-uploading-create-build) // -// # Related actions -// -// CreateBuild | ListBuilds | DescribeBuild | UpdateBuild | DeleteBuild | All -// APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -9390,8 +10017,8 @@ func (c *GameLift) RequestUploadCredentialsRequest(input *RequestUploadCredentia // parameter values before retrying. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - InternalServiceException // The service encountered an unrecoverable internal failure while processing @@ -9467,8 +10094,7 @@ func (c *GameLift) ResolveAliasRequest(input *ResolveAliasInput) (req *request.R // // # Related actions // -// CreateAlias | ListAliases | DescribeAlias | UpdateAlias | DeleteAlias | ResolveAlias -// | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -9487,8 +10113,8 @@ func (c *GameLift) ResolveAliasRequest(input *ResolveAliasInput) (req *request.R // parameter values before retrying. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - TerminalRoutingStrategyException // The service is unable to resolve the routing for a particular alias because @@ -9571,11 +10197,12 @@ func (c *GameLift) ResumeGameServerGroupRequest(input *ResumeGameServerGroupInpu // groups. // // Reinstates activity on a game server group after it has been suspended. A -// game server group might be suspended by theSuspendGameServerGroup operation, -// or it might be suspended involuntarily due to a configuration problem. In -// the second case, you can manually resume activity on the group once the configuration -// problem has been resolved. Refer to the game server group status and status -// reason for more information on why group activity is suspended. +// game server group might be suspended by the SuspendGameServerGroup (gamelift/latest/apireference/API_SuspendGameServerGroup.html) +// operation, or it might be suspended involuntarily due to a configuration +// problem. In the second case, you can manually resume activity on the group +// once the configuration problem has been resolved. Refer to the game server +// group status and status reason for more information on why group activity +// is suspended. // // To resume activity, specify a game server group ARN and the type of activity // to be resumed. If successful, a GameServerGroup object is returned showing @@ -9585,12 +10212,6 @@ func (c *GameLift) ResumeGameServerGroupRequest(input *ResumeGameServerGroupInpu // // GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) // -// # Related actions -// -// CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup | -// UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup | SuspendGameServerGroup -// | DescribeGameServerInstances | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/reference-awssdk-fleetiq.html) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -9605,8 +10226,8 @@ func (c *GameLift) ResumeGameServerGroupRequest(input *ResumeGameServerGroupInpu // parameter values before retrying. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - UnauthorizedException // The client failed authentication. Clients should not retry such requests. @@ -9717,17 +10338,16 @@ func (c *GameLift) SearchGameSessionsRequest(input *SearchGameSessionsInput) (re // // If successful, a GameSession object is returned for each game session that // matches the request. Search finds game sessions that are in ACTIVE status -// only. To retrieve information on game sessions in other statuses, use DescribeGameSessions. +// only. To retrieve information on game sessions in other statuses, use DescribeGameSessions +// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessions.html) . // // You can search or sort by the following game session attributes: // // - gameSessionId -- A unique identifier for the game session. You can use // either a GameSessionId or GameSessionArn value. // -// - gameSessionName -- Name assigned to a game session. This value is set -// when requesting a new game session with CreateGameSession or updating -// with UpdateGameSession. Game session names do not need to be unique to -// a game session. +// - gameSessionName -- Name assigned to a game session. Game session names +// do not need to be unique to a game session. // // - gameSessionProperties -- Custom data defined in a game session's GameProperty // parameter. GameProperty values are stored as key:value pairs; the filter @@ -9737,8 +10357,7 @@ func (c *GameLift) SearchGameSessionsRequest(input *SearchGameSessionsInput) (re // = "brawl". All custom data values are searched as strings. // // - maximumSessions -- Maximum number of player sessions allowed for a game -// session. This value is set when requesting a new game session with CreateGameSession -// or updating with UpdateGameSession. +// session. // // - creationTimeMillis -- Value indicating when a game session was created. // It is expressed in Unix time as milliseconds. @@ -9757,12 +10376,7 @@ func (c *GameLift) SearchGameSessionsRequest(input *SearchGameSessionsInput) (re // a snapshot in time. Be sure to refresh search results often, and handle sessions // that fill up before a player can join. // -// # Related actions -// -// CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions -// | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | -// DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -9779,8 +10393,8 @@ func (c *GameLift) SearchGameSessionsRequest(input *SearchGameSessionsInput) (re // period. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - InvalidRequestException // One or more parameter values in the request are invalid. Correct the invalid @@ -9916,9 +10530,10 @@ func (c *GameLift) StartFleetActionsRequest(input *StartFleetActionsInput) (req // StartFleetActions API operation for Amazon GameLift. // // Resumes certain types of activity on fleet instances that were suspended -// with StopFleetActions. For multi-location fleets, fleet actions are managed -// separately for each location. Currently, this operation is used to restart -// a fleet's auto-scaling activity. +// with StopFleetActions (https://docs.aws.amazon.com/gamelift/latest/apireference/API_StopFleetActions.html). +// For multi-location fleets, fleet actions are managed separately for each +// location. Currently, this operation is used to restart a fleet's auto-scaling +// activity. // // This operation can be used in the following ways: // @@ -9930,19 +10545,12 @@ func (c *GameLift) StartFleetActionsRequest(input *StartFleetActionsInput) (req // // If successful, GameLift once again initiates scaling events as triggered // by the fleet's scaling policies. If actions on the fleet location were never -// stopped, this operation will have no effect. You can view a fleet's stopped -// actions using DescribeFleetAttributes or DescribeFleetLocationAttributes. +// stopped, this operation will have no effect. // // # Learn more // // Setting up GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) // -// # Related actions -// -// CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits -// | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes -// | StopFleetActions | DeleteFleet | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -9965,8 +10573,8 @@ func (c *GameLift) StartFleetActionsRequest(input *StartFleetActionsInput) (req // The client failed authentication. Clients should not retry such requests. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - UnsupportedRegionException // The requested operation is not supported in the Region specified. @@ -10036,10 +10644,10 @@ func (c *GameLift) StartGameSessionPlacementRequest(input *StartGameSessionPlace // StartGameSessionPlacement API operation for Amazon GameLift. // -// Places a request for a new game session in a queue (see CreateGameSessionQueue). -// When processing a placement request, Amazon GameLift searches for available -// resources on the queue's destinations, scanning each until it finds resources -// or the placement request times out. +// Places a request for a new game session in a queue. When processing a placement +// request, Amazon GameLift searches for available resources on the queue's +// destinations, scanning each until it finds resources or the placement request +// times out. // // A game session placement request can also request player sessions. When a // new game session is successfully created, Amazon GameLift creates a player @@ -10074,18 +10682,12 @@ func (c *GameLift) StartGameSessionPlacementRequest(input *StartGameSessionPlace // If successful, a new game session placement is created. // // To track the status of a placement request, call DescribeGameSessionPlacement +// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionPlacement.html) // and check the request's status. If the status is FULFILLED, a new game session // has been created and a game session ARN and Region are referenced. If the // placement request times out, you can resubmit the request or retry it with // a different queue. // -// # Related actions -// -// CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions -// | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | -// DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -10105,8 +10707,8 @@ func (c *GameLift) StartGameSessionPlacementRequest(input *StartGameSessionPlace // parameter values before retrying. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - UnauthorizedException // The client failed authentication. Clients should not retry such requests. @@ -10184,13 +10786,13 @@ func (c *GameLift) StartMatchBackfillRequest(input *StartMatchBackfillInput) (re // so that backfilled match continues to meet the original match requirements. // // When using FlexMatch with GameLift managed hosting, you can request a backfill -// match from a client service by calling this operation with a GameSession -// identifier. You also have the option of making backfill requests directly -// from your game server. In response to a request, FlexMatch creates player -// sessions for the new players, updates the GameSession resource, and sends -// updated matchmaking data to the game server. You can request a backfill match -// at any point after a game session is started. Each game session can have -// only one active backfill request at a time; a subsequent request automatically +// match from a client service by calling this operation with a GameSessions +// ID. You also have the option of making backfill requests directly from your +// game server. In response to a request, FlexMatch creates player sessions +// for the new players, updates the GameSession resource, and sends updated +// matchmaking data to the game server. You can request a backfill match at +// any point after a game session is started. Each game session can have only +// one active backfill request at a time; a subsequent request automatically // replaces the earlier request. // // When using FlexMatch as a standalone component, request a backfill match @@ -10216,11 +10818,6 @@ func (c *GameLift) StartMatchBackfillRequest(input *StartMatchBackfillInput) (re // // How GameLift FlexMatch works (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/gamelift-match.html) // -// # Related actions -// -// StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch | -// StartMatchBackfill | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -10235,8 +10832,8 @@ func (c *GameLift) StartMatchBackfillRequest(input *StartMatchBackfillInput) (re // parameter values before retrying. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - InternalServiceException // The service encountered an unrecoverable internal failure while processing @@ -10338,11 +10935,6 @@ func (c *GameLift) StartMatchmakingRequest(input *StartMatchmakingInput) (req *r // // How GameLift FlexMatch works (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/gamelift-match.html) // -// # Related actions -// -// StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch | -// StartMatchBackfill | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -10357,8 +10949,8 @@ func (c *GameLift) StartMatchmakingRequest(input *StartMatchmakingInput) (req *r // parameter values before retrying. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - InternalServiceException // The service encountered an unrecoverable internal failure while processing @@ -10451,20 +11043,12 @@ func (c *GameLift) StopFleetActionsRequest(input *StopFleetActionsInput) (req *r // provide a fleet ID, a location name, and the type of actions to suspend. // // If successful, GameLift no longer initiates scaling events except in response -// to manual changes using UpdateFleetCapacity. You can view a fleet's stopped -// actions using DescribeFleetAttributes or DescribeFleetLocationAttributes. -// Suspended activity can be restarted using StartFleetActions. +// to manual changes using UpdateFleetCapacity (https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetCapacity.html). // // # Learn more // // Setting up GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) // -// # Related actions -// -// CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits -// | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes -// | StopFleetActions | DeleteFleet | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -10487,8 +11071,8 @@ func (c *GameLift) StopFleetActionsRequest(input *StopFleetActionsInput) (req *r // The client failed authentication. Clients should not retry such requests. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - UnsupportedRegionException // The requested operation is not supported in the Region specified. @@ -10562,13 +11146,6 @@ func (c *GameLift) StopGameSessionPlacementRequest(input *StopGameSessionPlaceme // provide the placement ID values. If successful, the placement is moved to // CANCELLED status. // -// # Related actions -// -// CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions -// | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | -// DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -10588,8 +11165,8 @@ func (c *GameLift) StopGameSessionPlacementRequest(input *StopGameSessionPlaceme // parameter values before retrying. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - UnauthorizedException // The client failed authentication. Clients should not retry such requests. @@ -10676,11 +11253,6 @@ func (c *GameLift) StopMatchmakingRequest(input *StopMatchmakingInput) (req *req // // Add FlexMatch to a game client (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html) // -// # Related actions -// -// StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch | -// StartMatchBackfill | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -10695,8 +11267,8 @@ func (c *GameLift) StopMatchmakingRequest(input *StopMatchmakingInput) (req *req // parameter values before retrying. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - InternalServiceException // The service encountered an unrecoverable internal failure while processing @@ -10775,8 +11347,9 @@ func (c *GameLift) SuspendGameServerGroupRequest(input *SuspendGameServerGroupIn // groups. // // Temporarily stops activity on a game server group without terminating instances -// or the game server group. You can restart activity by calling ResumeGameServerGroup. -// You can suspend the following activity: +// or the game server group. You can restart activity by calling ResumeGameServerGroup +// (gamelift/latest/apireference/API_ResumeGameServerGroup.html). You can suspend +// the following activity: // // - Instance type replacement - This activity evaluates the current game // hosting viability of all Spot instance types that are defined for the @@ -10795,12 +11368,6 @@ func (c *GameLift) SuspendGameServerGroupRequest(input *SuspendGameServerGroupIn // // GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) // -// # Related actions -// -// CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup | -// UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup | SuspendGameServerGroup -// | DescribeGameServerInstances | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/reference-awssdk-fleetiq.html) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -10815,8 +11382,8 @@ func (c *GameLift) SuspendGameServerGroupRequest(input *SuspendGameServerGroupIn // parameter values before retrying. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - UnauthorizedException // The client failed authentication. Clients should not retry such requests. @@ -10927,7 +11494,7 @@ func (c *GameLift) TagResourceRequest(input *TagResourceInput) (req *request.Req // // # Related actions // -// TagResource | UntagResource | ListTagsForResource | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -10939,8 +11506,8 @@ func (c *GameLift) TagResourceRequest(input *TagResourceInput) (req *request.Req // Returned Error Types: // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - InvalidRequestException // One or more parameter values in the request are invalid. Correct the invalid @@ -11055,7 +11622,7 @@ func (c *GameLift) UntagResourceRequest(input *UntagResourceInput) (req *request // // # Related actions // -// TagResource | UntagResource | ListTagsForResource | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -11067,8 +11634,8 @@ func (c *GameLift) UntagResourceRequest(input *UntagResourceInput) (req *request // Returned Error Types: // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - InvalidRequestException // One or more parameter values in the request are invalid. Correct the invalid @@ -11156,8 +11723,7 @@ func (c *GameLift) UpdateAliasRequest(input *UpdateAliasInput) (req *request.Req // // # Related actions // -// CreateAlias | ListAliases | DescribeAlias | UpdateAlias | DeleteAlias | ResolveAlias -// | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -11176,8 +11742,8 @@ func (c *GameLift) UpdateAliasRequest(input *UpdateAliasInput) (req *request.Req // parameter values before retrying. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - InternalServiceException // The service encountered an unrecoverable internal failure while processing @@ -11258,10 +11824,7 @@ func (c *GameLift) UpdateBuildRequest(input *UpdateBuildInput) (req *request.Req // // Upload a Custom Server Build (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html) // -// # Related actions -// -// CreateBuild | ListBuilds | DescribeBuild | UpdateBuild | DeleteBuild | All -// APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -11280,8 +11843,8 @@ func (c *GameLift) UpdateBuildRequest(input *UpdateBuildInput) (req *request.Req // parameter values before retrying. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - InternalServiceException // The service encountered an unrecoverable internal failure while processing @@ -11365,13 +11928,6 @@ func (c *GameLift) UpdateFleetAttributesRequest(input *UpdateFleetAttributesInpu // // Setting up GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) // -// # Related actions -// -// CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity | UpdateFleetPortSettings -// | UpdateRuntimeConfiguration | StopFleetActions | StartFleetActions | PutScalingPolicy -// | DeleteFleet | DeleteFleetLocations | DeleteScalingPolicy | All APIs by -// task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -11382,8 +11938,8 @@ func (c *GameLift) UpdateFleetAttributesRequest(input *UpdateFleetAttributesInpu // Returned Error Types: // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - ConflictException // The requested operation would cause a conflict with the current state of @@ -11488,9 +12044,9 @@ func (c *GameLift) UpdateFleetCapacityRequest(input *UpdateFleetCapacityInput) ( // // - Desired capacity: Manually set the number of Amazon EC2 instances to // be maintained in a fleet location. Before changing a fleet's desired capacity, -// you may want to call DescribeEC2InstanceLimits to get the maximum capacity -// of the fleet's Amazon EC2 instance type. Alternatively, consider using -// automatic scaling to adjust capacity based on player demand. +// you may want to call DescribeEC2InstanceLimits (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeEC2InstanceLimits.html) +// to get the maximum capacity of the fleet's Amazon EC2 instance type. Alternatively, +// consider using automatic scaling to adjust capacity based on player demand. // // This operation can be used in the following ways: // @@ -11507,20 +12063,15 @@ func (c *GameLift) UpdateFleetCapacityRequest(input *UpdateFleetCapacityInput) ( // existing instances in the requested fleet location. This continues until // the location's active instance count matches the new desired instance count. // You can track a fleet's current capacity by calling DescribeFleetCapacity -// or DescribeFleetLocationCapacity. If the requested desired instance count -// is higher than the instance type's limit, the LimitExceeded exception occurs. +// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetCapacity.html) +// or DescribeFleetLocationCapacity (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html). +// If the requested desired instance count is higher than the instance type's +// limit, the LimitExceeded exception occurs. // // # Learn more // // Scaling fleet capacity (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-manage-capacity.html) // -// # Related actions -// -// CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity | UpdateFleetPortSettings -// | UpdateRuntimeConfiguration | StopFleetActions | StartFleetActions | PutScalingPolicy -// | DeleteFleet | DeleteFleetLocations | DeleteScalingPolicy | All APIs by -// task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -11531,8 +12082,8 @@ func (c *GameLift) UpdateFleetCapacityRequest(input *UpdateFleetCapacityInput) ( // Returned Error Types: // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - ConflictException // The requested operation would cause a conflict with the current state of @@ -11645,13 +12196,6 @@ func (c *GameLift) UpdateFleetPortSettingsRequest(input *UpdateFleetPortSettings // // Setting up GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) // -// # Related actions -// -// CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity | UpdateFleetPortSettings -// | UpdateRuntimeConfiguration | StopFleetActions | StartFleetActions | PutScalingPolicy -// | DeleteFleet | DeleteFleetLocations | DeleteScalingPolicy | All APIs by -// task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -11662,8 +12206,8 @@ func (c *GameLift) UpdateFleetPortSettingsRequest(input *UpdateFleetPortSettings // Returned Error Types: // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - ConflictException // The requested operation would cause a conflict with the current state of @@ -11787,11 +12331,6 @@ func (c *GameLift) UpdateGameServerRequest(input *UpdateGameServerInput) (req *r // // GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) // -// # Related actions -// -// RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer -// | UpdateGameServer | DeregisterGameServer | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/reference-awssdk-fleetiq.html) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -11806,8 +12345,8 @@ func (c *GameLift) UpdateGameServerRequest(input *UpdateGameServerInput) (req *r // parameter values before retrying. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - UnauthorizedException // The client failed authentication. Clients should not retry such requests. @@ -11899,12 +12438,6 @@ func (c *GameLift) UpdateGameServerGroupRequest(input *UpdateGameServerGroupInpu // // GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) // -// # Related actions -// -// CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup | -// UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup | SuspendGameServerGroup -// | DescribeGameServerInstances | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/reference-awssdk-fleetiq.html) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -11919,8 +12452,8 @@ func (c *GameLift) UpdateGameServerGroupRequest(input *UpdateGameServerGroupInpu // parameter values before retrying. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - UnauthorizedException // The client failed authentication. Clients should not retry such requests. @@ -12002,12 +12535,7 @@ func (c *GameLift) UpdateGameSessionRequest(input *UpdateGameSessionInput) (req // // If successful, the updated GameSession object is returned. // -// # Related actions -// -// CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions -// | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | -// DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -12019,8 +12547,8 @@ func (c *GameLift) UpdateGameSessionRequest(input *UpdateGameSessionInput) (req // Returned Error Types: // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - ConflictException // The requested operation would cause a conflict with the current state of @@ -12118,14 +12646,6 @@ func (c *GameLift) UpdateGameSessionQueueRequest(input *UpdateGameSessionQueueIn // // Using Multi-Region Queues (https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html) // -// # Related actions -// -// CreateGameSessionQueue (https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateGameSessionQueue.html) -// | DescribeGameSessionQueues (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionQueues.html) -// | UpdateGameSessionQueue (https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSessionQueue.html) -// | DeleteGameSessionQueue (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteGameSessionQueue.html) -// | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -12145,8 +12665,8 @@ func (c *GameLift) UpdateGameSessionQueueRequest(input *UpdateGameSessionQueueIn // parameter values before retrying. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - UnauthorizedException // The client failed authentication. Clients should not retry such requests. @@ -12225,13 +12745,6 @@ func (c *GameLift) UpdateMatchmakingConfigurationRequest(input *UpdateMatchmakin // // Design a FlexMatch matchmaker (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-configuration.html) // -// # Related actions -// -// CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations | UpdateMatchmakingConfiguration -// | DeleteMatchmakingConfiguration | CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets -// | ValidateMatchmakingRuleSet | DeleteMatchmakingRuleSet | All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -12246,8 +12759,8 @@ func (c *GameLift) UpdateMatchmakingConfigurationRequest(input *UpdateMatchmakin // parameter values before retrying. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - InternalServiceException // The service encountered an unrecoverable internal failure while processing @@ -12341,13 +12854,6 @@ func (c *GameLift) UpdateRuntimeConfigurationRequest(input *UpdateRuntimeConfigu // // Setting up GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) // -// # Related actions -// -// CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity | UpdateFleetPortSettings -// | UpdateRuntimeConfiguration | StopFleetActions | StartFleetActions | PutScalingPolicy -// | DeleteFleet | DeleteFleetLocations | DeleteScalingPolicy | All APIs by -// task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -12361,8 +12867,8 @@ func (c *GameLift) UpdateRuntimeConfigurationRequest(input *UpdateRuntimeConfigu // The client failed authentication. Clients should not retry such requests. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - InternalServiceException // The service encountered an unrecoverable internal failure while processing @@ -12464,8 +12970,7 @@ func (c *GameLift) UpdateScriptRequest(input *UpdateScriptInput) (req *request.R // // # Related actions // -// CreateScript | ListScripts | DescribeScript | UpdateScript | DeleteScript -// | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -12484,8 +12989,8 @@ func (c *GameLift) UpdateScriptRequest(input *UpdateScriptInput) (req *request.R // parameter values before retrying. // // - NotFoundException -// A service resource associated with the request could not be found. Clients -// should not retry such requests. +// THe requested resources was not found. The resource was either not created +// yet or deleted. // // - InternalServiceException // The service encountered an unrecoverable internal failure while processing @@ -12566,13 +13071,6 @@ func (c *GameLift) ValidateMatchmakingRuleSetRequest(input *ValidateMatchmakingR // // - Build a rule set (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html) // -// # Related actions -// -// CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations | UpdateMatchmakingConfiguration -// | DeleteMatchmakingConfiguration | CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets -// | ValidateMatchmakingRuleSet | DeleteMatchmakingRuleSet | All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -12616,7 +13114,6 @@ func (c *GameLift) ValidateMatchmakingRuleSetWithContext(ctx aws.Context, input return out, req.Send() } -// Represents the input for a request operation. type AcceptMatchInput struct { _ struct{} `type:"structure"` @@ -12719,8 +13216,7 @@ func (s AcceptMatchOutput) GoString() string { // // # Related actions // -// CreateAlias | ListAliases | DescribeAlias | UpdateAlias | DeleteAlias | ResolveAlias -// | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) type Alias struct { _ struct{} `type:"structure"` @@ -12813,7 +13309,59 @@ func (s *Alias) SetRoutingStrategy(v *RoutingStrategy) *Alias { return s } -// Values for use in Player attribute key-value pairs. This object lets you +// GameLift Anywhere configuration options for your Anywhere fleets. +type AnywhereConfiguration struct { + _ struct{} `type:"structure"` + + // The cost to run your fleet per hour. GameLift uses the provided cost of your + // fleet to balance usage in queues. For more information about queues, see + // Setting up queues (https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html). + // + // Cost is a required field + Cost *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AnywhereConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AnywhereConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *AnywhereConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "AnywhereConfiguration"} + if s.Cost == nil { + invalidParams.Add(request.NewErrParamRequired("Cost")) + } + if s.Cost != nil && len(*s.Cost) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Cost", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCost sets the Cost field's value. +func (s *AnywhereConfiguration) SetCost(v string) *AnywhereConfiguration { + s.Cost = &v + return s +} + +// Values for use in player attribute key-value pairs. This object lets you // specify an attribute value using any of the valid data types: string, number, // string array, or data map. Each AttributeValue object can use only one of // the available properties. @@ -12893,7 +13441,7 @@ func (s *AttributeValue) SetSL(v []*string) *AttributeValue { // Temporary access credentials used for uploading game build files to Amazon // GameLift. They are valid for a limited time. If they expire before you upload -// your game build, get a new set by calling RequestUploadCredentials. +// your game build, get a new set by calling RequestUploadCredentials (https://docs.aws.amazon.com/gamelift/latest/apireference/API_RequestUploadCredentials.html). type AwsCredentials struct { _ struct{} `type:"structure" sensitive:"true"` @@ -12946,16 +13494,13 @@ func (s *AwsCredentials) SetSessionToken(v string) *AwsCredentials { // Properties describing a custom game build. // -// # Related actions -// -// CreateBuild | ListBuilds | DescribeBuild | UpdateBuild | DeleteBuild | All -// APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) type Build struct { _ struct{} `type:"structure"` // The Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) - // that is assigned to a GameLift build resource and uniquely identifies it. - // ARNs are unique across all Regions. Format is arn:aws:gamelift:For more information about pipes, see +// Amazon EventBridge Pipes in the Amazon EventBridge User Guide.
+// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon EventBridge Pipes's +// API operation UpdatePipe for usage and error information. +// +// Returned Error Types: +// +// - InternalException +// This exception occurs due to unexpected causes. +// +// - ValidationException +// Indicates that an error has occurred while performing a validate operation. +// +// - ThrottlingException +// An action was throttled. +// +// - NotFoundException +// An entity that you specified does not exist. +// +// - ConflictException +// An action you attempted resulted in an exception. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/UpdatePipe +func (c *Pipes) UpdatePipe(input *UpdatePipeInput) (*UpdatePipeOutput, error) { + req, out := c.UpdatePipeRequest(input) + return out, req.Send() +} + +// UpdatePipeWithContext is the same as UpdatePipe with the addition of +// the ability to pass a context and additional request options. +// +// See UpdatePipe for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Pipes) UpdatePipeWithContext(ctx aws.Context, input *UpdatePipeInput, opts ...request.Option) (*UpdatePipeOutput, error) { + req, out := c.UpdatePipeRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// This structure specifies the VPC subnets and security groups for the task, +// and whether a public IP address is to be used. This structure is relevant +// only for ECS tasks that use the awsvpc network mode. +type AwsVpcConfiguration struct { + _ struct{} `type:"structure"` + + // Specifies whether the task's elastic network interface receives a public + // IP address. You can specify ENABLED only when LaunchType in EcsParameters + // is set to FARGATE. + AssignPublicIp *string `type:"string" enum:"AssignPublicIp"` + + // Specifies the security groups associated with the task. These security groups + // must all be in the same VPC. You can specify as many as five security groups. + // If you do not specify a security group, the default security group for the + // VPC is used. + SecurityGroups []*string `type:"list"` + + // Specifies the subnets associated with the task. These subnets must all be + // in the same VPC. You can specify as many as 16 subnets. + // + // Subnets is a required field + Subnets []*string `type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AwsVpcConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AwsVpcConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *AwsVpcConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "AwsVpcConfiguration"} + if s.Subnets == nil { + invalidParams.Add(request.NewErrParamRequired("Subnets")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAssignPublicIp sets the AssignPublicIp field's value. +func (s *AwsVpcConfiguration) SetAssignPublicIp(v string) *AwsVpcConfiguration { + s.AssignPublicIp = &v + return s +} + +// SetSecurityGroups sets the SecurityGroups field's value. +func (s *AwsVpcConfiguration) SetSecurityGroups(v []*string) *AwsVpcConfiguration { + s.SecurityGroups = v + return s +} + +// SetSubnets sets the Subnets field's value. +func (s *AwsVpcConfiguration) SetSubnets(v []*string) *AwsVpcConfiguration { + s.Subnets = v + return s +} + +// The array properties for the submitted job, such as the size of the array. +// The array size can be between 2 and 10,000. If you specify array properties +// for a job, it becomes an array job. This parameter is used only if the target +// is an Batch job. +type BatchArrayProperties struct { + _ struct{} `type:"structure"` + + // The size of the array, if this is an array batch job. + Size *int64 `min:"2" type:"integer"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s BatchArrayProperties) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s BatchArrayProperties) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *BatchArrayProperties) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "BatchArrayProperties"} + if s.Size != nil && *s.Size < 2 { + invalidParams.Add(request.NewErrParamMinValue("Size", 2)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetSize sets the Size field's value. +func (s *BatchArrayProperties) SetSize(v int64) *BatchArrayProperties { + s.Size = &v + return s +} + +// The overrides that are sent to a container. +type BatchContainerOverrides struct { + _ struct{} `type:"structure"` + + // The command to send to the container that overrides the default command from + // the Docker image or the task definition. + Command []*string `type:"list"` + + // The environment variables to send to the container. You can add new environment + // variables, which are added to the container at launch, or you can override + // the existing environment variables from the Docker image or the task definition. + // + // Environment variables cannot start with "Batch". This naming convention is + // reserved for variables that Batch sets. + Environment []*BatchEnvironmentVariable `type:"list"` + + // The instance type to use for a multi-node parallel job. + // + // This parameter isn't applicable to single-node container jobs or jobs that + // run on Fargate resources, and shouldn't be provided. + InstanceType *string `type:"string"` + + // The type and amount of resources to assign to a container. This overrides + // the settings in the job definition. The supported resources include GPU, + // MEMORY, and VCPU. + ResourceRequirements []*BatchResourceRequirement `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s BatchContainerOverrides) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s BatchContainerOverrides) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *BatchContainerOverrides) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "BatchContainerOverrides"} + if s.ResourceRequirements != nil { + for i, v := range s.ResourceRequirements { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "ResourceRequirements", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCommand sets the Command field's value. +func (s *BatchContainerOverrides) SetCommand(v []*string) *BatchContainerOverrides { + s.Command = v + return s +} + +// SetEnvironment sets the Environment field's value. +func (s *BatchContainerOverrides) SetEnvironment(v []*BatchEnvironmentVariable) *BatchContainerOverrides { + s.Environment = v + return s +} + +// SetInstanceType sets the InstanceType field's value. +func (s *BatchContainerOverrides) SetInstanceType(v string) *BatchContainerOverrides { + s.InstanceType = &v + return s +} + +// SetResourceRequirements sets the ResourceRequirements field's value. +func (s *BatchContainerOverrides) SetResourceRequirements(v []*BatchResourceRequirement) *BatchContainerOverrides { + s.ResourceRequirements = v + return s +} + +// The environment variables to send to the container. You can add new environment +// variables, which are added to the container at launch, or you can override +// the existing environment variables from the Docker image or the task definition. +// +// Environment variables cannot start with "Batch". This naming convention is +// reserved for variables that Batch sets. +type BatchEnvironmentVariable struct { + _ struct{} `type:"structure"` + + // The name of the key-value pair. For environment variables, this is the name + // of the environment variable. + Name *string `type:"string"` + + // The value of the key-value pair. For environment variables, this is the value + // of the environment variable. + Value *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s BatchEnvironmentVariable) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s BatchEnvironmentVariable) GoString() string { + return s.String() +} + +// SetName sets the Name field's value. +func (s *BatchEnvironmentVariable) SetName(v string) *BatchEnvironmentVariable { + s.Name = &v + return s +} + +// SetValue sets the Value field's value. +func (s *BatchEnvironmentVariable) SetValue(v string) *BatchEnvironmentVariable { + s.Value = &v + return s +} + +// An object that represents an Batch job dependency. +type BatchJobDependency struct { + _ struct{} `type:"structure"` + + // The job ID of the Batch job that's associated with this dependency. + JobId *string `type:"string"` + + // The type of the job dependency. + Type *string `type:"string" enum:"BatchJobDependencyType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s BatchJobDependency) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s BatchJobDependency) GoString() string { + return s.String() +} + +// SetJobId sets the JobId field's value. +func (s *BatchJobDependency) SetJobId(v string) *BatchJobDependency { + s.JobId = &v + return s +} + +// SetType sets the Type field's value. +func (s *BatchJobDependency) SetType(v string) *BatchJobDependency { + s.Type = &v + return s +} + +// The type and amount of a resource to assign to a container. The supported +// resources include GPU, MEMORY, and VCPU. +type BatchResourceRequirement struct { + _ struct{} `type:"structure"` + + // The type of resource to assign to a container. The supported resources include + // GPU, MEMORY, and VCPU. + // + // Type is a required field + Type *string `type:"string" required:"true" enum:"BatchResourceRequirementType"` + + // The quantity of the specified resource to reserve for the container. The + // values vary based on the type specified. + // + // type="GPU" + // + // The number of physical GPUs to reserve for the container. Make sure that + // the number of GPUs reserved for all containers in a job doesn't exceed the + // number of available GPUs on the compute resource that the job is launched + // on. + // + // GPUs aren't available for jobs that are running on Fargate resources. + // + // type="MEMORY" + // + // The memory hard limit (in MiB) present to the container. This parameter is + // supported for jobs that are running on EC2 resources. If your container attempts + // to exceed the memory specified, the container is terminated. This parameter + // maps to Memory in the Create a container (https://docs.docker.com/engine/api/v1.23/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/) + // and the --memory option to docker run (https://docs.docker.com/engine/reference/run/). + // You must specify at least 4 MiB of memory for a job. This is required but + // can be specified in several places for multi-node parallel (MNP) jobs. It + // must be specified for each node at least once. This parameter maps to Memory + // in the Create a container (https://docs.docker.com/engine/api/v1.23/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/) + // and the --memory option to docker run (https://docs.docker.com/engine/reference/run/). + // + // If you're trying to maximize your resource utilization by providing your + // jobs as much memory as possible for a particular instance type, see Memory + // management (https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html) + // in the Batch User Guide. + // + // For jobs that are running on Fargate resources, then value is the hard limit + // (in MiB), and must match one of the supported values and the VCPU values + // must be one of the values supported for that memory value. + // + // value = 512 + // + // VCPU = 0.25 + // + // value = 1024 + // + // VCPU = 0.25 or 0.5 + // + // value = 2048 + // + // VCPU = 0.25, 0.5, or 1 + // + // value = 3072 + // + // VCPU = 0.5, or 1 + // + // value = 4096 + // + // VCPU = 0.5, 1, or 2 + // + // value = 5120, 6144, or 7168 + // + // VCPU = 1 or 2 + // + // value = 8192 + // + // VCPU = 1, 2, 4, or 8 + // + // value = 9216, 10240, 11264, 12288, 13312, 14336, or 15360 + // + // VCPU = 2 or 4 + // + // value = 16384 + // + // VCPU = 2, 4, or 8 + // + // value = 17408, 18432, 19456, 21504, 22528, 23552, 25600, 26624, 27648, 29696, + // or 30720 + // + // VCPU = 4 + // + // value = 20480, 24576, or 28672 + // + // VCPU = 4 or 8 + // + // value = 36864, 45056, 53248, or 61440 + // + // VCPU = 8 + // + // value = 32768, 40960, 49152, or 57344 + // + // VCPU = 8 or 16 + // + // value = 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880 + // + // VCPU = 16 + // + // type="VCPU" + // + // The number of vCPUs reserved for the container. This parameter maps to CpuShares + // in the Create a container (https://docs.docker.com/engine/api/v1.23/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/) + // and the --cpu-shares option to docker run (https://docs.docker.com/engine/reference/run/). + // Each vCPU is equivalent to 1,024 CPU shares. For EC2 resources, you must + // specify at least one vCPU. This is required but can be specified in several + // places; it must be specified for each node at least once. + // + // The default for the Fargate On-Demand vCPU resource count quota is 6 vCPUs. + // For more information about Fargate quotas, see Fargate quotas (https://docs.aws.amazon.com/general/latest/gr/ecs-service.html#service-quotas-fargate) + // in the Amazon Web Services General Reference. + // + // For jobs that are running on Fargate resources, then value must match one + // of the supported values and the MEMORY values must be one of the values supported + // for that VCPU value. The supported values are 0.25, 0.5, 1, 2, 4, 8, and + // 16 + // + // value = 0.25 + // + // MEMORY = 512, 1024, or 2048 + // + // value = 0.5 + // + // MEMORY = 1024, 2048, 3072, or 4096 + // + // value = 1 + // + // MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192 + // + // value = 2 + // + // MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, + // 14336, 15360, or 16384 + // + // value = 4 + // + // MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, + // 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, + // 29696, or 30720 + // + // value = 8 + // + // MEMORY = 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, + // 57344, or 61440 + // + // value = 16 + // + // MEMORY = 32768, 40960, 49152, 57344, 65536, 73728, 81920, 90112, 98304, 106496, + // 114688, or 122880 + // + // Value is a required field + Value *string `type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s BatchResourceRequirement) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s BatchResourceRequirement) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *BatchResourceRequirement) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "BatchResourceRequirement"} + if s.Type == nil { + invalidParams.Add(request.NewErrParamRequired("Type")) + } + if s.Value == nil { + invalidParams.Add(request.NewErrParamRequired("Value")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetType sets the Type field's value. +func (s *BatchResourceRequirement) SetType(v string) *BatchResourceRequirement { + s.Type = &v + return s +} + +// SetValue sets the Value field's value. +func (s *BatchResourceRequirement) SetValue(v string) *BatchResourceRequirement { + s.Value = &v + return s +} + +// The retry strategy that's associated with a job. For more information, see +// Automated job retries (https://docs.aws.amazon.com/batch/latest/userguide/job_retries.html) +// in the Batch User Guide. +type BatchRetryStrategy struct { + _ struct{} `type:"structure"` + + // The number of times to move a job to the RUNNABLE status. If the value of + // attempts is greater than one, the job is retried on failure the same number + // of attempts as the value. + Attempts *int64 `min:"1" type:"integer"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s BatchRetryStrategy) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s BatchRetryStrategy) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *BatchRetryStrategy) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "BatchRetryStrategy"} + if s.Attempts != nil && *s.Attempts < 1 { + invalidParams.Add(request.NewErrParamMinValue("Attempts", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAttempts sets the Attempts field's value. +func (s *BatchRetryStrategy) SetAttempts(v int64) *BatchRetryStrategy { + s.Attempts = &v + return s +} + +// The details of a capacity provider strategy. To learn more, see CapacityProviderStrategyItem +// (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CapacityProviderStrategyItem.html) +// in the Amazon ECS API Reference. +type CapacityProviderStrategyItem struct { + _ struct{} `type:"structure"` + + // The base value designates how many tasks, at a minimum, to run on the specified + // capacity provider. Only one capacity provider in a capacity provider strategy + // can have a base defined. If no value is specified, the default value of 0 + // is used. + Base *int64 `locationName:"base" type:"integer"` + + // The short name of the capacity provider. + // + // CapacityProvider is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by CapacityProviderStrategyItem's + // String and GoString methods. + // + // CapacityProvider is a required field + CapacityProvider *string `locationName:"capacityProvider" min:"1" type:"string" required:"true" sensitive:"true"` + + // The weight value designates the relative percentage of the total number of + // tasks launched that should use the specified capacity provider. The weight + // value is taken into consideration after the base value, if defined, is satisfied. + Weight *int64 `locationName:"weight" type:"integer"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CapacityProviderStrategyItem) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CapacityProviderStrategyItem) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CapacityProviderStrategyItem) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CapacityProviderStrategyItem"} + if s.CapacityProvider == nil { + invalidParams.Add(request.NewErrParamRequired("CapacityProvider")) + } + if s.CapacityProvider != nil && len(*s.CapacityProvider) < 1 { + invalidParams.Add(request.NewErrParamMinLen("CapacityProvider", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBase sets the Base field's value. +func (s *CapacityProviderStrategyItem) SetBase(v int64) *CapacityProviderStrategyItem { + s.Base = &v + return s +} + +// SetCapacityProvider sets the CapacityProvider field's value. +func (s *CapacityProviderStrategyItem) SetCapacityProvider(v string) *CapacityProviderStrategyItem { + s.CapacityProvider = &v + return s +} + +// SetWeight sets the Weight field's value. +func (s *CapacityProviderStrategyItem) SetWeight(v int64) *CapacityProviderStrategyItem { + s.Weight = &v + return s +} + +// An action you attempted resulted in an exception. +type ConflictException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" type:"string"` + + // The ID of the resource that caused the exception. + // + // ResourceId is a required field + ResourceId *string `locationName:"resourceId" type:"string" required:"true"` + + // The type of resource that caused the exception. + // + // ResourceType is a required field + ResourceType *string `locationName:"resourceType" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConflictException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConflictException) GoString() string { + return s.String() +} + +func newErrorConflictException(v protocol.ResponseMetadata) error { + return &ConflictException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ConflictException) Code() string { + return "ConflictException" +} + +// Message returns the exception's message. +func (s *ConflictException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ConflictException) OrigErr() error { + return nil +} + +func (s *ConflictException) Error() string { + return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ConflictException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ConflictException) RequestID() string { + return s.RespMetadata.RequestID +} + +type CreatePipeInput struct { + _ struct{} `type:"structure"` + + // A description of the pipe. + // + // Description is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by CreatePipeInput's + // String and GoString methods. + Description *string `type:"string" sensitive:"true"` + + // The state the pipe should be in. + DesiredState *string `type:"string" enum:"RequestedPipeState"` + + // The ARN of the enrichment resource. + Enrichment *string `type:"string"` + + // The parameters required to set up enrichment on your pipe. + EnrichmentParameters *PipeEnrichmentParameters `type:"structure"` + + // The name of the pipe. + // + // Name is a required field + Name *string `location:"uri" locationName:"Name" min:"1" type:"string" required:"true"` + + // The ARN of the role that allows the pipe to send data to the target. + // + // RoleArn is a required field + RoleArn *string `min:"1" type:"string" required:"true"` + + // The ARN of the source resource. + // + // Source is a required field + Source *string `min:"1" type:"string" required:"true"` + + // The parameters required to set up a source for your pipe. + SourceParameters *PipeSourceParameters `type:"structure"` + + // The list of key-value pairs to associate with the pipe. + Tags map[string]*string `min:"1" type:"map"` + + // The ARN of the target resource. + // + // Target is a required field + Target *string `min:"1" type:"string" required:"true"` + + // The parameters required to set up a target for your pipe. + TargetParameters *PipeTargetParameters `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreatePipeInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreatePipeInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreatePipeInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreatePipeInput"} + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.RoleArn == nil { + invalidParams.Add(request.NewErrParamRequired("RoleArn")) + } + if s.RoleArn != nil && len(*s.RoleArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("RoleArn", 1)) + } + if s.Source == nil { + invalidParams.Add(request.NewErrParamRequired("Source")) + } + if s.Source != nil && len(*s.Source) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Source", 1)) + } + if s.Tags != nil && len(s.Tags) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Tags", 1)) + } + if s.Target == nil { + invalidParams.Add(request.NewErrParamRequired("Target")) + } + if s.Target != nil && len(*s.Target) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Target", 1)) + } + if s.SourceParameters != nil { + if err := s.SourceParameters.Validate(); err != nil { + invalidParams.AddNested("SourceParameters", err.(request.ErrInvalidParams)) + } + } + if s.TargetParameters != nil { + if err := s.TargetParameters.Validate(); err != nil { + invalidParams.AddNested("TargetParameters", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDescription sets the Description field's value. +func (s *CreatePipeInput) SetDescription(v string) *CreatePipeInput { + s.Description = &v + return s +} + +// SetDesiredState sets the DesiredState field's value. +func (s *CreatePipeInput) SetDesiredState(v string) *CreatePipeInput { + s.DesiredState = &v + return s +} + +// SetEnrichment sets the Enrichment field's value. +func (s *CreatePipeInput) SetEnrichment(v string) *CreatePipeInput { + s.Enrichment = &v + return s +} + +// SetEnrichmentParameters sets the EnrichmentParameters field's value. +func (s *CreatePipeInput) SetEnrichmentParameters(v *PipeEnrichmentParameters) *CreatePipeInput { + s.EnrichmentParameters = v + return s +} + +// SetName sets the Name field's value. +func (s *CreatePipeInput) SetName(v string) *CreatePipeInput { + s.Name = &v + return s +} + +// SetRoleArn sets the RoleArn field's value. +func (s *CreatePipeInput) SetRoleArn(v string) *CreatePipeInput { + s.RoleArn = &v + return s +} + +// SetSource sets the Source field's value. +func (s *CreatePipeInput) SetSource(v string) *CreatePipeInput { + s.Source = &v + return s +} + +// SetSourceParameters sets the SourceParameters field's value. +func (s *CreatePipeInput) SetSourceParameters(v *PipeSourceParameters) *CreatePipeInput { + s.SourceParameters = v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreatePipeInput) SetTags(v map[string]*string) *CreatePipeInput { + s.Tags = v + return s +} + +// SetTarget sets the Target field's value. +func (s *CreatePipeInput) SetTarget(v string) *CreatePipeInput { + s.Target = &v + return s +} + +// SetTargetParameters sets the TargetParameters field's value. +func (s *CreatePipeInput) SetTargetParameters(v *PipeTargetParameters) *CreatePipeInput { + s.TargetParameters = v + return s +} + +type CreatePipeOutput struct { + _ struct{} `type:"structure"` + + // The ARN of the pipe. + Arn *string `min:"1" type:"string"` + + // The time the pipe was created. + CreationTime *time.Time `type:"timestamp"` + + // The state the pipe is in. + CurrentState *string `type:"string" enum:"PipeState"` + + // The state the pipe should be in. + DesiredState *string `type:"string" enum:"RequestedPipeState"` + + // When the pipe was last updated, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime) + // (YYYY-MM-DDThh:mm:ss.sTZD). + LastModifiedTime *time.Time `type:"timestamp"` + + // The name of the pipe. + Name *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreatePipeOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreatePipeOutput) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *CreatePipeOutput) SetArn(v string) *CreatePipeOutput { + s.Arn = &v + return s +} + +// SetCreationTime sets the CreationTime field's value. +func (s *CreatePipeOutput) SetCreationTime(v time.Time) *CreatePipeOutput { + s.CreationTime = &v + return s +} + +// SetCurrentState sets the CurrentState field's value. +func (s *CreatePipeOutput) SetCurrentState(v string) *CreatePipeOutput { + s.CurrentState = &v + return s +} + +// SetDesiredState sets the DesiredState field's value. +func (s *CreatePipeOutput) SetDesiredState(v string) *CreatePipeOutput { + s.DesiredState = &v + return s +} + +// SetLastModifiedTime sets the LastModifiedTime field's value. +func (s *CreatePipeOutput) SetLastModifiedTime(v time.Time) *CreatePipeOutput { + s.LastModifiedTime = &v + return s +} + +// SetName sets the Name field's value. +func (s *CreatePipeOutput) SetName(v string) *CreatePipeOutput { + s.Name = &v + return s +} + +// A DeadLetterConfig object that contains information about a dead-letter queue +// configuration. +type DeadLetterConfig struct { + _ struct{} `type:"structure"` + + // The ARN of the Amazon SQS queue specified as the target for the dead-letter + // queue. + Arn *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeadLetterConfig) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeadLetterConfig) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeadLetterConfig) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeadLetterConfig"} + if s.Arn != nil && len(*s.Arn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Arn", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetArn sets the Arn field's value. +func (s *DeadLetterConfig) SetArn(v string) *DeadLetterConfig { + s.Arn = &v + return s +} + +type DeletePipeInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The name of the pipe. + // + // Name is a required field + Name *string `location:"uri" locationName:"Name" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeletePipeInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeletePipeInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeletePipeInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeletePipeInput"} + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetName sets the Name field's value. +func (s *DeletePipeInput) SetName(v string) *DeletePipeInput { + s.Name = &v + return s +} + +type DeletePipeOutput struct { + _ struct{} `type:"structure"` + + // The ARN of the pipe. + Arn *string `min:"1" type:"string"` + + // The time the pipe was created. + CreationTime *time.Time `type:"timestamp"` + + // The state the pipe is in. + CurrentState *string `type:"string" enum:"PipeState"` + + // The state the pipe should be in. + DesiredState *string `type:"string" enum:"RequestedPipeStateDescribeResponse"` + + // When the pipe was last updated, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime) + // (YYYY-MM-DDThh:mm:ss.sTZD). + LastModifiedTime *time.Time `type:"timestamp"` + + // The name of the pipe. + Name *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeletePipeOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeletePipeOutput) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *DeletePipeOutput) SetArn(v string) *DeletePipeOutput { + s.Arn = &v + return s +} + +// SetCreationTime sets the CreationTime field's value. +func (s *DeletePipeOutput) SetCreationTime(v time.Time) *DeletePipeOutput { + s.CreationTime = &v + return s +} + +// SetCurrentState sets the CurrentState field's value. +func (s *DeletePipeOutput) SetCurrentState(v string) *DeletePipeOutput { + s.CurrentState = &v + return s +} + +// SetDesiredState sets the DesiredState field's value. +func (s *DeletePipeOutput) SetDesiredState(v string) *DeletePipeOutput { + s.DesiredState = &v + return s +} + +// SetLastModifiedTime sets the LastModifiedTime field's value. +func (s *DeletePipeOutput) SetLastModifiedTime(v time.Time) *DeletePipeOutput { + s.LastModifiedTime = &v + return s +} + +// SetName sets the Name field's value. +func (s *DeletePipeOutput) SetName(v string) *DeletePipeOutput { + s.Name = &v + return s +} + +type DescribePipeInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The name of the pipe. + // + // Name is a required field + Name *string `location:"uri" locationName:"Name" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribePipeInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribePipeInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribePipeInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribePipeInput"} + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetName sets the Name field's value. +func (s *DescribePipeInput) SetName(v string) *DescribePipeInput { + s.Name = &v + return s +} + +type DescribePipeOutput struct { + _ struct{} `type:"structure"` + + // The ARN of the pipe. + Arn *string `min:"1" type:"string"` + + // The time the pipe was created. + CreationTime *time.Time `type:"timestamp"` + + // The state the pipe is in. + CurrentState *string `type:"string" enum:"PipeState"` + + // A description of the pipe. + // + // Description is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by DescribePipeOutput's + // String and GoString methods. + Description *string `type:"string" sensitive:"true"` + + // The state the pipe should be in. + DesiredState *string `type:"string" enum:"RequestedPipeStateDescribeResponse"` + + // The ARN of the enrichment resource. + Enrichment *string `type:"string"` + + // The parameters required to set up enrichment on your pipe. + EnrichmentParameters *PipeEnrichmentParameters `type:"structure"` + + // When the pipe was last updated, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime) + // (YYYY-MM-DDThh:mm:ss.sTZD). + LastModifiedTime *time.Time `type:"timestamp"` + + // The name of the pipe. + Name *string `min:"1" type:"string"` + + // The ARN of the role that allows the pipe to send data to the target. + RoleArn *string `min:"1" type:"string"` + + // The ARN of the source resource. + Source *string `min:"1" type:"string"` + + // The parameters required to set up a source for your pipe. + SourceParameters *PipeSourceParameters `type:"structure"` + + // The reason the pipe is in its current state. + StateReason *string `type:"string"` + + // The list of key-value pairs to associate with the pipe. + Tags map[string]*string `min:"1" type:"map"` + + // The ARN of the target resource. + Target *string `min:"1" type:"string"` + + // The parameters required to set up a target for your pipe. + TargetParameters *PipeTargetParameters `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribePipeOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribePipeOutput) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *DescribePipeOutput) SetArn(v string) *DescribePipeOutput { + s.Arn = &v + return s +} + +// SetCreationTime sets the CreationTime field's value. +func (s *DescribePipeOutput) SetCreationTime(v time.Time) *DescribePipeOutput { + s.CreationTime = &v + return s +} + +// SetCurrentState sets the CurrentState field's value. +func (s *DescribePipeOutput) SetCurrentState(v string) *DescribePipeOutput { + s.CurrentState = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *DescribePipeOutput) SetDescription(v string) *DescribePipeOutput { + s.Description = &v + return s +} + +// SetDesiredState sets the DesiredState field's value. +func (s *DescribePipeOutput) SetDesiredState(v string) *DescribePipeOutput { + s.DesiredState = &v + return s +} + +// SetEnrichment sets the Enrichment field's value. +func (s *DescribePipeOutput) SetEnrichment(v string) *DescribePipeOutput { + s.Enrichment = &v + return s +} + +// SetEnrichmentParameters sets the EnrichmentParameters field's value. +func (s *DescribePipeOutput) SetEnrichmentParameters(v *PipeEnrichmentParameters) *DescribePipeOutput { + s.EnrichmentParameters = v + return s +} + +// SetLastModifiedTime sets the LastModifiedTime field's value. +func (s *DescribePipeOutput) SetLastModifiedTime(v time.Time) *DescribePipeOutput { + s.LastModifiedTime = &v + return s +} + +// SetName sets the Name field's value. +func (s *DescribePipeOutput) SetName(v string) *DescribePipeOutput { + s.Name = &v + return s +} + +// SetRoleArn sets the RoleArn field's value. +func (s *DescribePipeOutput) SetRoleArn(v string) *DescribePipeOutput { + s.RoleArn = &v + return s +} + +// SetSource sets the Source field's value. +func (s *DescribePipeOutput) SetSource(v string) *DescribePipeOutput { + s.Source = &v + return s +} + +// SetSourceParameters sets the SourceParameters field's value. +func (s *DescribePipeOutput) SetSourceParameters(v *PipeSourceParameters) *DescribePipeOutput { + s.SourceParameters = v + return s +} + +// SetStateReason sets the StateReason field's value. +func (s *DescribePipeOutput) SetStateReason(v string) *DescribePipeOutput { + s.StateReason = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *DescribePipeOutput) SetTags(v map[string]*string) *DescribePipeOutput { + s.Tags = v + return s +} + +// SetTarget sets the Target field's value. +func (s *DescribePipeOutput) SetTarget(v string) *DescribePipeOutput { + s.Target = &v + return s +} + +// SetTargetParameters sets the TargetParameters field's value. +func (s *DescribePipeOutput) SetTargetParameters(v *PipeTargetParameters) *DescribePipeOutput { + s.TargetParameters = v + return s +} + +// The overrides that are sent to a container. An empty container override can +// be passed in. An example of an empty container override is {"containerOverrides": +// [ ] }. If a non-empty container override is specified, the name parameter +// must be included. +type EcsContainerOverride struct { + _ struct{} `type:"structure"` + + // The command to send to the container that overrides the default command from + // the Docker image or the task definition. You must also specify a container + // name. + Command []*string `type:"list"` + + // The number of cpu units reserved for the container, instead of the default + // value from the task definition. You must also specify a container name. + Cpu *int64 `type:"integer"` + + // The environment variables to send to the container. You can add new environment + // variables, which are added to the container at launch, or you can override + // the existing environment variables from the Docker image or the task definition. + // You must also specify a container name. + Environment []*EcsEnvironmentVariable `type:"list"` + + // A list of files containing the environment variables to pass to a container, + // instead of the value from the container definition. + EnvironmentFiles []*EcsEnvironmentFile `type:"list"` + + // The hard limit (in MiB) of memory to present to the container, instead of + // the default value from the task definition. If your container attempts to + // exceed the memory specified here, the container is killed. You must also + // specify a container name. + Memory *int64 `type:"integer"` + + // The soft limit (in MiB) of memory to reserve for the container, instead of + // the default value from the task definition. You must also specify a container + // name. + MemoryReservation *int64 `type:"integer"` + + // The name of the container that receives the override. This parameter is required + // if any override is specified. + Name *string `type:"string"` + + // The type and amount of a resource to assign to a container, instead of the + // default value from the task definition. The only supported resource is a + // GPU. + ResourceRequirements []*EcsResourceRequirement `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EcsContainerOverride) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EcsContainerOverride) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *EcsContainerOverride) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "EcsContainerOverride"} + if s.EnvironmentFiles != nil { + for i, v := range s.EnvironmentFiles { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "EnvironmentFiles", i), err.(request.ErrInvalidParams)) + } + } + } + if s.ResourceRequirements != nil { + for i, v := range s.ResourceRequirements { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "ResourceRequirements", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCommand sets the Command field's value. +func (s *EcsContainerOverride) SetCommand(v []*string) *EcsContainerOverride { + s.Command = v + return s +} + +// SetCpu sets the Cpu field's value. +func (s *EcsContainerOverride) SetCpu(v int64) *EcsContainerOverride { + s.Cpu = &v + return s +} + +// SetEnvironment sets the Environment field's value. +func (s *EcsContainerOverride) SetEnvironment(v []*EcsEnvironmentVariable) *EcsContainerOverride { + s.Environment = v + return s +} + +// SetEnvironmentFiles sets the EnvironmentFiles field's value. +func (s *EcsContainerOverride) SetEnvironmentFiles(v []*EcsEnvironmentFile) *EcsContainerOverride { + s.EnvironmentFiles = v + return s +} + +// SetMemory sets the Memory field's value. +func (s *EcsContainerOverride) SetMemory(v int64) *EcsContainerOverride { + s.Memory = &v + return s +} + +// SetMemoryReservation sets the MemoryReservation field's value. +func (s *EcsContainerOverride) SetMemoryReservation(v int64) *EcsContainerOverride { + s.MemoryReservation = &v + return s +} + +// SetName sets the Name field's value. +func (s *EcsContainerOverride) SetName(v string) *EcsContainerOverride { + s.Name = &v + return s +} + +// SetResourceRequirements sets the ResourceRequirements field's value. +func (s *EcsContainerOverride) SetResourceRequirements(v []*EcsResourceRequirement) *EcsContainerOverride { + s.ResourceRequirements = v + return s +} + +// A list of files containing the environment variables to pass to a container. +// You can specify up to ten environment files. The file must have a .env file +// extension. Each line in an environment file should contain an environment +// variable in VARIABLE=VALUE format. Lines beginning with # are treated as +// comments and are ignored. For more information about the environment variable +// file syntax, see Declare default environment variables in file (https://docs.docker.com/compose/env-file/). +// +// If there are environment variables specified using the environment parameter +// in a container definition, they take precedence over the variables contained +// within an environment file. If multiple environment files are specified that +// contain the same variable, they're processed from the top down. We recommend +// that you use unique variable names. For more information, see Specifying +// environment variables (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html) +// in the Amazon Elastic Container Service Developer Guide. +// +// This parameter is only supported for tasks hosted on Fargate using the following +// platform versions: +// +// - Linux platform version 1.4.0 or later. +// +// - Windows platform version 1.0.0 or later. +type EcsEnvironmentFile struct { + _ struct{} `type:"structure"` + + // The file type to use. The only supported value is s3. + // + // Type is a required field + Type *string `locationName:"type" type:"string" required:"true" enum:"EcsEnvironmentFileType"` + + // The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment + // variable file. + // + // Value is a required field + Value *string `locationName:"value" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EcsEnvironmentFile) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EcsEnvironmentFile) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *EcsEnvironmentFile) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "EcsEnvironmentFile"} + if s.Type == nil { + invalidParams.Add(request.NewErrParamRequired("Type")) + } + if s.Value == nil { + invalidParams.Add(request.NewErrParamRequired("Value")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetType sets the Type field's value. +func (s *EcsEnvironmentFile) SetType(v string) *EcsEnvironmentFile { + s.Type = &v + return s +} + +// SetValue sets the Value field's value. +func (s *EcsEnvironmentFile) SetValue(v string) *EcsEnvironmentFile { + s.Value = &v + return s +} + +// The environment variables to send to the container. You can add new environment +// variables, which are added to the container at launch, or you can override +// the existing environment variables from the Docker image or the task definition. +// You must also specify a container name. +type EcsEnvironmentVariable struct { + _ struct{} `type:"structure"` + + // The name of the key-value pair. For environment variables, this is the name + // of the environment variable. + Name *string `locationName:"name" type:"string"` + + // The value of the key-value pair. For environment variables, this is the value + // of the environment variable. + Value *string `locationName:"value" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EcsEnvironmentVariable) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EcsEnvironmentVariable) GoString() string { + return s.String() +} + +// SetName sets the Name field's value. +func (s *EcsEnvironmentVariable) SetName(v string) *EcsEnvironmentVariable { + s.Name = &v + return s +} + +// SetValue sets the Value field's value. +func (s *EcsEnvironmentVariable) SetValue(v string) *EcsEnvironmentVariable { + s.Value = &v + return s +} + +// The amount of ephemeral storage to allocate for the task. This parameter +// is used to expand the total amount of ephemeral storage available, beyond +// the default amount, for tasks hosted on Fargate. For more information, see +// Fargate task storage (https://docs.aws.amazon.com/AmazonECS/latest/userguide/using_data_volumes.html) +// in the Amazon ECS User Guide for Fargate. +// +// This parameter is only supported for tasks hosted on Fargate using Linux +// platform version 1.4.0 or later. This parameter is not supported for Windows +// containers on Fargate. +type EcsEphemeralStorage struct { + _ struct{} `type:"structure"` + + // The total amount, in GiB, of ephemeral storage to set for the task. The minimum + // supported value is 21 GiB and the maximum supported value is 200 GiB. + // + // SizeInGiB is a required field + SizeInGiB *int64 `locationName:"sizeInGiB" min:"21" type:"integer" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EcsEphemeralStorage) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EcsEphemeralStorage) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *EcsEphemeralStorage) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "EcsEphemeralStorage"} + if s.SizeInGiB == nil { + invalidParams.Add(request.NewErrParamRequired("SizeInGiB")) + } + if s.SizeInGiB != nil && *s.SizeInGiB < 21 { + invalidParams.Add(request.NewErrParamMinValue("SizeInGiB", 21)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetSizeInGiB sets the SizeInGiB field's value. +func (s *EcsEphemeralStorage) SetSizeInGiB(v int64) *EcsEphemeralStorage { + s.SizeInGiB = &v + return s +} + +// Details on an Elastic Inference accelerator task override. This parameter +// is used to override the Elastic Inference accelerator specified in the task +// definition. For more information, see Working with Amazon Elastic Inference +// on Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/userguide/ecs-inference.html) +// in the Amazon Elastic Container Service Developer Guide. +type EcsInferenceAcceleratorOverride struct { + _ struct{} `type:"structure"` + + // The Elastic Inference accelerator device name to override for the task. This + // parameter must match a deviceName specified in the task definition. + DeviceName *string `locationName:"deviceName" type:"string"` + + // The Elastic Inference accelerator type to use. + DeviceType *string `locationName:"deviceType" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EcsInferenceAcceleratorOverride) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EcsInferenceAcceleratorOverride) GoString() string { + return s.String() +} + +// SetDeviceName sets the DeviceName field's value. +func (s *EcsInferenceAcceleratorOverride) SetDeviceName(v string) *EcsInferenceAcceleratorOverride { + s.DeviceName = &v + return s +} + +// SetDeviceType sets the DeviceType field's value. +func (s *EcsInferenceAcceleratorOverride) SetDeviceType(v string) *EcsInferenceAcceleratorOverride { + s.DeviceType = &v + return s +} + +// The type and amount of a resource to assign to a container. The supported +// resource types are GPUs and Elastic Inference accelerators. For more information, +// see Working with GPUs on Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-gpu.html) +// or Working with Amazon Elastic Inference on Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html) +// in the Amazon Elastic Container Service Developer Guide +type EcsResourceRequirement struct { + _ struct{} `type:"structure"` + + // The type of resource to assign to a container. The supported values are GPU + // or InferenceAccelerator. + // + // Type is a required field + Type *string `locationName:"type" type:"string" required:"true" enum:"EcsResourceRequirementType"` + + // The value for the specified resource type. + // + // If the GPU type is used, the value is the number of physical GPUs the Amazon + // ECS container agent reserves for the container. The number of GPUs that's + // reserved for all containers in a task can't exceed the number of available + // GPUs on the container instance that the task is launched on. + // + // If the InferenceAccelerator type is used, the value matches the deviceName + // for an InferenceAccelerator specified in a task definition. + // + // Value is a required field + Value *string `locationName:"value" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EcsResourceRequirement) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EcsResourceRequirement) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *EcsResourceRequirement) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "EcsResourceRequirement"} + if s.Type == nil { + invalidParams.Add(request.NewErrParamRequired("Type")) + } + if s.Value == nil { + invalidParams.Add(request.NewErrParamRequired("Value")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetType sets the Type field's value. +func (s *EcsResourceRequirement) SetType(v string) *EcsResourceRequirement { + s.Type = &v + return s +} + +// SetValue sets the Value field's value. +func (s *EcsResourceRequirement) SetValue(v string) *EcsResourceRequirement { + s.Value = &v + return s +} + +// The overrides that are associated with a task. +type EcsTaskOverride struct { + _ struct{} `type:"structure"` + + // One or more container overrides that are sent to a task. + ContainerOverrides []*EcsContainerOverride `type:"list"` + + // The cpu override for the task. + Cpu *string `type:"string"` + + // The ephemeral storage setting override for the task. + // + // This parameter is only supported for tasks hosted on Fargate that use the + // following platform versions: + // + // * Linux platform version 1.4.0 or later. + // + // * Windows platform version 1.0.0 or later. + EphemeralStorage *EcsEphemeralStorage `type:"structure"` + + // The Amazon Resource Name (ARN) of the task execution IAM role override for + // the task. For more information, see Amazon ECS task execution IAM role (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html) + // in the Amazon Elastic Container Service Developer Guide. + ExecutionRoleArn *string `min:"1" type:"string"` + + // The Elastic Inference accelerator override for the task. + InferenceAcceleratorOverrides []*EcsInferenceAcceleratorOverride `type:"list"` + + // The memory override for the task. + Memory *string `type:"string"` + + // The Amazon Resource Name (ARN) of the IAM role that containers in this task + // can assume. All containers in this task are granted the permissions that + // are specified in this role. For more information, see IAM Role for Tasks + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) + // in the Amazon Elastic Container Service Developer Guide. + TaskRoleArn *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EcsTaskOverride) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EcsTaskOverride) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *EcsTaskOverride) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "EcsTaskOverride"} + if s.ExecutionRoleArn != nil && len(*s.ExecutionRoleArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ExecutionRoleArn", 1)) + } + if s.TaskRoleArn != nil && len(*s.TaskRoleArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TaskRoleArn", 1)) + } + if s.ContainerOverrides != nil { + for i, v := range s.ContainerOverrides { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "ContainerOverrides", i), err.(request.ErrInvalidParams)) + } + } + } + if s.EphemeralStorage != nil { + if err := s.EphemeralStorage.Validate(); err != nil { + invalidParams.AddNested("EphemeralStorage", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetContainerOverrides sets the ContainerOverrides field's value. +func (s *EcsTaskOverride) SetContainerOverrides(v []*EcsContainerOverride) *EcsTaskOverride { + s.ContainerOverrides = v + return s +} + +// SetCpu sets the Cpu field's value. +func (s *EcsTaskOverride) SetCpu(v string) *EcsTaskOverride { + s.Cpu = &v + return s +} + +// SetEphemeralStorage sets the EphemeralStorage field's value. +func (s *EcsTaskOverride) SetEphemeralStorage(v *EcsEphemeralStorage) *EcsTaskOverride { + s.EphemeralStorage = v + return s +} + +// SetExecutionRoleArn sets the ExecutionRoleArn field's value. +func (s *EcsTaskOverride) SetExecutionRoleArn(v string) *EcsTaskOverride { + s.ExecutionRoleArn = &v + return s +} + +// SetInferenceAcceleratorOverrides sets the InferenceAcceleratorOverrides field's value. +func (s *EcsTaskOverride) SetInferenceAcceleratorOverrides(v []*EcsInferenceAcceleratorOverride) *EcsTaskOverride { + s.InferenceAcceleratorOverrides = v + return s +} + +// SetMemory sets the Memory field's value. +func (s *EcsTaskOverride) SetMemory(v string) *EcsTaskOverride { + s.Memory = &v + return s +} + +// SetTaskRoleArn sets the TaskRoleArn field's value. +func (s *EcsTaskOverride) SetTaskRoleArn(v string) *EcsTaskOverride { + s.TaskRoleArn = &v + return s +} + +// Filter events using an event pattern. For more information, see Events and +// Event Patterns (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) +// in the Amazon EventBridge User Guide. +type Filter struct { + _ struct{} `type:"structure"` + + // The event pattern. + // + // Pattern is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by Filter's + // String and GoString methods. + Pattern *string `type:"string" sensitive:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Filter) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Filter) GoString() string { + return s.String() +} + +// SetPattern sets the Pattern field's value. +func (s *Filter) SetPattern(v string) *Filter { + s.Pattern = &v + return s +} + +// The collection of event patterns used to filter events. For more information, +// see Events and Event Patterns (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) +// in the Amazon EventBridge User Guide. +type FilterCriteria struct { + _ struct{} `type:"structure"` + + // The event patterns. + Filters []*Filter `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s FilterCriteria) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s FilterCriteria) GoString() string { + return s.String() +} + +// SetFilters sets the Filters field's value. +func (s *FilterCriteria) SetFilters(v []*Filter) *FilterCriteria { + s.Filters = v + return s +} + +// This exception occurs due to unexpected causes. +type InternalException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" type:"string"` + + // The number of seconds to wait before retrying the action that caused the + // exception. + RetryAfterSeconds *int64 `location:"header" locationName:"Retry-After" type:"integer"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InternalException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InternalException) GoString() string { + return s.String() +} + +func newErrorInternalException(v protocol.ResponseMetadata) error { + return &InternalException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *InternalException) Code() string { + return "InternalException" +} + +// Message returns the exception's message. +func (s *InternalException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *InternalException) OrigErr() error { + return nil +} + +func (s *InternalException) Error() string { + return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *InternalException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *InternalException) RequestID() string { + return s.RespMetadata.RequestID +} + +type ListPipesInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The state the pipe is in. + CurrentState *string `location:"querystring" locationName:"CurrentState" type:"string" enum:"PipeState"` + + // The state the pipe should be in. + DesiredState *string `location:"querystring" locationName:"DesiredState" type:"string" enum:"RequestedPipeState"` + + // The maximum number of pipes to include in the response. + Limit *int64 `location:"querystring" locationName:"Limit" min:"1" type:"integer"` + + // A value that will return a subset of the pipes associated with this account. + // For example, "NamePrefix": "ABC" will return all endpoints with "ABC" in + // the name. + NamePrefix *string `location:"querystring" locationName:"NamePrefix" min:"1" type:"string"` + + // If nextToken is returned, there are more results available. The value of + // nextToken is a unique pagination token for each page. Make the call again + // using the returned token to retrieve the next page. Keep all other arguments + // unchanged. Each pagination token expires after 24 hours. Using an expired + // pagination token will return an HTTP 400 InvalidToken error. + // + // NextToken is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by ListPipesInput's + // String and GoString methods. + NextToken *string `location:"querystring" locationName:"NextToken" min:"1" type:"string" sensitive:"true"` + + // The prefix matching the pipe source. + SourcePrefix *string `location:"querystring" locationName:"SourcePrefix" min:"1" type:"string"` + + // The prefix matching the pipe target. + TargetPrefix *string `location:"querystring" locationName:"TargetPrefix" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListPipesInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListPipesInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListPipesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListPipesInput"} + if s.Limit != nil && *s.Limit < 1 { + invalidParams.Add(request.NewErrParamMinValue("Limit", 1)) + } + if s.NamePrefix != nil && len(*s.NamePrefix) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NamePrefix", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + if s.SourcePrefix != nil && len(*s.SourcePrefix) < 1 { + invalidParams.Add(request.NewErrParamMinLen("SourcePrefix", 1)) + } + if s.TargetPrefix != nil && len(*s.TargetPrefix) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TargetPrefix", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCurrentState sets the CurrentState field's value. +func (s *ListPipesInput) SetCurrentState(v string) *ListPipesInput { + s.CurrentState = &v + return s +} + +// SetDesiredState sets the DesiredState field's value. +func (s *ListPipesInput) SetDesiredState(v string) *ListPipesInput { + s.DesiredState = &v + return s +} + +// SetLimit sets the Limit field's value. +func (s *ListPipesInput) SetLimit(v int64) *ListPipesInput { + s.Limit = &v + return s +} + +// SetNamePrefix sets the NamePrefix field's value. +func (s *ListPipesInput) SetNamePrefix(v string) *ListPipesInput { + s.NamePrefix = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListPipesInput) SetNextToken(v string) *ListPipesInput { + s.NextToken = &v + return s +} + +// SetSourcePrefix sets the SourcePrefix field's value. +func (s *ListPipesInput) SetSourcePrefix(v string) *ListPipesInput { + s.SourcePrefix = &v + return s +} + +// SetTargetPrefix sets the TargetPrefix field's value. +func (s *ListPipesInput) SetTargetPrefix(v string) *ListPipesInput { + s.TargetPrefix = &v + return s +} + +type ListPipesOutput struct { + _ struct{} `type:"structure"` + + // If nextToken is returned, there are more results available. The value of + // nextToken is a unique pagination token for each page. Make the call again + // using the returned token to retrieve the next page. Keep all other arguments + // unchanged. Each pagination token expires after 24 hours. Using an expired + // pagination token will return an HTTP 400 InvalidToken error. + // + // NextToken is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by ListPipesOutput's + // String and GoString methods. + NextToken *string `min:"1" type:"string" sensitive:"true"` + + // The pipes returned by the call. + Pipes []*Pipe `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListPipesOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListPipesOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListPipesOutput) SetNextToken(v string) *ListPipesOutput { + s.NextToken = &v + return s +} + +// SetPipes sets the Pipes field's value. +func (s *ListPipesOutput) SetPipes(v []*Pipe) *ListPipesOutput { + s.Pipes = v + return s +} + +type ListTagsForResourceInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The ARN of the pipe for which you want to view tags. + // + // ResourceArn is a required field + ResourceArn *string `location:"uri" locationName:"resourceArn" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTagsForResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTagsForResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListTagsForResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListTagsForResourceInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ResourceArn != nil && len(*s.ResourceArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput { + s.ResourceArn = &v + return s +} + +type ListTagsForResourceOutput struct { + _ struct{} `type:"structure"` + + // The list of key-value pairs to associate with the pipe. + Tags map[string]*string `locationName:"tags" min:"1" type:"map"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTagsForResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTagsForResourceOutput) GoString() string { + return s.String() +} + +// SetTags sets the Tags field's value. +func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput { + s.Tags = v + return s +} + +// The Secrets Manager secret that stores your broker credentials. +type MQBrokerAccessCredentials struct { + _ struct{} `type:"structure"` + + // The ARN of the Secrets Manager secret. + BasicAuth *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s MQBrokerAccessCredentials) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s MQBrokerAccessCredentials) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *MQBrokerAccessCredentials) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "MQBrokerAccessCredentials"} + if s.BasicAuth != nil && len(*s.BasicAuth) < 1 { + invalidParams.Add(request.NewErrParamMinLen("BasicAuth", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBasicAuth sets the BasicAuth field's value. +func (s *MQBrokerAccessCredentials) SetBasicAuth(v string) *MQBrokerAccessCredentials { + s.BasicAuth = &v + return s +} + +// The Secrets Manager secret that stores your stream credentials. +type MSKAccessCredentials struct { + _ struct{} `type:"structure"` + + // The ARN of the Secrets Manager secret. + ClientCertificateTlsAuth *string `min:"1" type:"string"` + + // The ARN of the Secrets Manager secret. + SaslScram512Auth *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s MSKAccessCredentials) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s MSKAccessCredentials) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *MSKAccessCredentials) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "MSKAccessCredentials"} + if s.ClientCertificateTlsAuth != nil && len(*s.ClientCertificateTlsAuth) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientCertificateTlsAuth", 1)) + } + if s.SaslScram512Auth != nil && len(*s.SaslScram512Auth) < 1 { + invalidParams.Add(request.NewErrParamMinLen("SaslScram512Auth", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetClientCertificateTlsAuth sets the ClientCertificateTlsAuth field's value. +func (s *MSKAccessCredentials) SetClientCertificateTlsAuth(v string) *MSKAccessCredentials { + s.ClientCertificateTlsAuth = &v + return s +} + +// SetSaslScram512Auth sets the SaslScram512Auth field's value. +func (s *MSKAccessCredentials) SetSaslScram512Auth(v string) *MSKAccessCredentials { + s.SaslScram512Auth = &v + return s +} + +// This structure specifies the network configuration for an Amazon ECS task. +type NetworkConfiguration struct { + _ struct{} `type:"structure"` + + // Use this structure to specify the VPC subnets and security groups for the + // task, and whether a public IP address is to be used. This structure is relevant + // only for ECS tasks that use the awsvpc network mode. + AwsvpcConfiguration *AwsVpcConfiguration `locationName:"awsvpcConfiguration" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s NetworkConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s NetworkConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *NetworkConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "NetworkConfiguration"} + if s.AwsvpcConfiguration != nil { + if err := s.AwsvpcConfiguration.Validate(); err != nil { + invalidParams.AddNested("AwsvpcConfiguration", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAwsvpcConfiguration sets the AwsvpcConfiguration field's value. +func (s *NetworkConfiguration) SetAwsvpcConfiguration(v *AwsVpcConfiguration) *NetworkConfiguration { + s.AwsvpcConfiguration = v + return s +} + +// An entity that you specified does not exist. +type NotFoundException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s NotFoundException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s NotFoundException) GoString() string { + return s.String() +} + +func newErrorNotFoundException(v protocol.ResponseMetadata) error { + return &NotFoundException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *NotFoundException) Code() string { + return "NotFoundException" +} + +// Message returns the exception's message. +func (s *NotFoundException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *NotFoundException) OrigErr() error { + return nil +} + +func (s *NotFoundException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *NotFoundException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *NotFoundException) RequestID() string { + return s.RespMetadata.RequestID +} + +// An object that represents a pipe. Amazon EventBridgePipes connect event sources +// to targets and reduces the need for specialized knowledge and integration +// code. +type Pipe struct { + _ struct{} `type:"structure"` + + // The ARN of the pipe. + Arn *string `min:"1" type:"string"` + + // The time the pipe was created. + CreationTime *time.Time `type:"timestamp"` + + // The state the pipe is in. + CurrentState *string `type:"string" enum:"PipeState"` + + // The state the pipe should be in. + DesiredState *string `type:"string" enum:"RequestedPipeState"` + + // The ARN of the enrichment resource. + Enrichment *string `type:"string"` + + // When the pipe was last updated, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime) + // (YYYY-MM-DDThh:mm:ss.sTZD). + LastModifiedTime *time.Time `type:"timestamp"` + + // The name of the pipe. + Name *string `min:"1" type:"string"` + + // The ARN of the source resource. + Source *string `min:"1" type:"string"` + + // The reason the pipe is in its current state. + StateReason *string `type:"string"` + + // The ARN of the target resource. + Target *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Pipe) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Pipe) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *Pipe) SetArn(v string) *Pipe { + s.Arn = &v + return s +} + +// SetCreationTime sets the CreationTime field's value. +func (s *Pipe) SetCreationTime(v time.Time) *Pipe { + s.CreationTime = &v + return s +} + +// SetCurrentState sets the CurrentState field's value. +func (s *Pipe) SetCurrentState(v string) *Pipe { + s.CurrentState = &v + return s +} + +// SetDesiredState sets the DesiredState field's value. +func (s *Pipe) SetDesiredState(v string) *Pipe { + s.DesiredState = &v + return s +} + +// SetEnrichment sets the Enrichment field's value. +func (s *Pipe) SetEnrichment(v string) *Pipe { + s.Enrichment = &v + return s +} + +// SetLastModifiedTime sets the LastModifiedTime field's value. +func (s *Pipe) SetLastModifiedTime(v time.Time) *Pipe { + s.LastModifiedTime = &v + return s +} + +// SetName sets the Name field's value. +func (s *Pipe) SetName(v string) *Pipe { + s.Name = &v + return s +} + +// SetSource sets the Source field's value. +func (s *Pipe) SetSource(v string) *Pipe { + s.Source = &v + return s +} + +// SetStateReason sets the StateReason field's value. +func (s *Pipe) SetStateReason(v string) *Pipe { + s.StateReason = &v + return s +} + +// SetTarget sets the Target field's value. +func (s *Pipe) SetTarget(v string) *Pipe { + s.Target = &v + return s +} + +// These are custom parameter to be used when the target is an API Gateway REST +// APIs or EventBridge ApiDestinations. In the latter case, these are merged +// with any InvocationParameters specified on the Connection, with any values +// from the Connection taking precedence. +type PipeEnrichmentHttpParameters struct { + _ struct{} `type:"structure"` + + // The headers that need to be sent as part of request invoking the API Gateway + // REST API or EventBridge ApiDestination. + HeaderParameters map[string]*string `type:"map"` + + // The path parameter values to be used to populate API Gateway REST API or + // EventBridge ApiDestination path wildcards ("*"). + PathParameterValues []*string `type:"list"` + + // The query string keys/values that need to be sent as part of request invoking + // the API Gateway REST API or EventBridge ApiDestination. + QueryStringParameters map[string]*string `type:"map"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeEnrichmentHttpParameters) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeEnrichmentHttpParameters) GoString() string { + return s.String() +} + +// SetHeaderParameters sets the HeaderParameters field's value. +func (s *PipeEnrichmentHttpParameters) SetHeaderParameters(v map[string]*string) *PipeEnrichmentHttpParameters { + s.HeaderParameters = v + return s +} + +// SetPathParameterValues sets the PathParameterValues field's value. +func (s *PipeEnrichmentHttpParameters) SetPathParameterValues(v []*string) *PipeEnrichmentHttpParameters { + s.PathParameterValues = v + return s +} + +// SetQueryStringParameters sets the QueryStringParameters field's value. +func (s *PipeEnrichmentHttpParameters) SetQueryStringParameters(v map[string]*string) *PipeEnrichmentHttpParameters { + s.QueryStringParameters = v + return s +} + +// The parameters required to set up enrichment on your pipe. +type PipeEnrichmentParameters struct { + _ struct{} `type:"structure"` + + // Contains the HTTP parameters to use when the target is a API Gateway REST + // endpoint or EventBridge ApiDestination. + // + // If you specify an API Gateway REST API or EventBridge ApiDestination as a + // target, you can use this parameter to specify headers, path parameters, and + // query string keys/values as part of your target invoking request. If you're + // using ApiDestinations, the corresponding Connection can also have these values + // configured. In case of any conflicting keys, values from the Connection take + // precedence. + HttpParameters *PipeEnrichmentHttpParameters `type:"structure"` + + // Valid JSON text passed to the enrichment. In this case, nothing from the + // event itself is passed to the enrichment. For more information, see The JavaScript + // Object Notation (JSON) Data Interchange Format (http://www.rfc-editor.org/rfc/rfc7159.txt). + // + // InputTemplate is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by PipeEnrichmentParameters's + // String and GoString methods. + InputTemplate *string `type:"string" sensitive:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeEnrichmentParameters) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeEnrichmentParameters) GoString() string { + return s.String() +} + +// SetHttpParameters sets the HttpParameters field's value. +func (s *PipeEnrichmentParameters) SetHttpParameters(v *PipeEnrichmentHttpParameters) *PipeEnrichmentParameters { + s.HttpParameters = v + return s +} + +// SetInputTemplate sets the InputTemplate field's value. +func (s *PipeEnrichmentParameters) SetInputTemplate(v string) *PipeEnrichmentParameters { + s.InputTemplate = &v + return s +} + +// The parameters for using an Active MQ broker as a source. +type PipeSourceActiveMQBrokerParameters struct { + _ struct{} `type:"structure"` + + // The maximum number of records to include in each batch. + BatchSize *int64 `min:"1" type:"integer"` + + // The credentials needed to access the resource. + // + // Credentials is a required field + Credentials *MQBrokerAccessCredentials `type:"structure" required:"true"` + + // The maximum length of a time to wait for events. + MaximumBatchingWindowInSeconds *int64 `type:"integer"` + + // The name of the destination queue to consume. + // + // QueueName is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by PipeSourceActiveMQBrokerParameters's + // String and GoString methods. + // + // QueueName is a required field + QueueName *string `min:"1" type:"string" required:"true" sensitive:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeSourceActiveMQBrokerParameters) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeSourceActiveMQBrokerParameters) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *PipeSourceActiveMQBrokerParameters) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "PipeSourceActiveMQBrokerParameters"} + if s.BatchSize != nil && *s.BatchSize < 1 { + invalidParams.Add(request.NewErrParamMinValue("BatchSize", 1)) + } + if s.Credentials == nil { + invalidParams.Add(request.NewErrParamRequired("Credentials")) + } + if s.QueueName == nil { + invalidParams.Add(request.NewErrParamRequired("QueueName")) + } + if s.QueueName != nil && len(*s.QueueName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("QueueName", 1)) + } + if s.Credentials != nil { + if err := s.Credentials.Validate(); err != nil { + invalidParams.AddNested("Credentials", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBatchSize sets the BatchSize field's value. +func (s *PipeSourceActiveMQBrokerParameters) SetBatchSize(v int64) *PipeSourceActiveMQBrokerParameters { + s.BatchSize = &v + return s +} + +// SetCredentials sets the Credentials field's value. +func (s *PipeSourceActiveMQBrokerParameters) SetCredentials(v *MQBrokerAccessCredentials) *PipeSourceActiveMQBrokerParameters { + s.Credentials = v + return s +} + +// SetMaximumBatchingWindowInSeconds sets the MaximumBatchingWindowInSeconds field's value. +func (s *PipeSourceActiveMQBrokerParameters) SetMaximumBatchingWindowInSeconds(v int64) *PipeSourceActiveMQBrokerParameters { + s.MaximumBatchingWindowInSeconds = &v + return s +} + +// SetQueueName sets the QueueName field's value. +func (s *PipeSourceActiveMQBrokerParameters) SetQueueName(v string) *PipeSourceActiveMQBrokerParameters { + s.QueueName = &v + return s +} + +// The parameters for using a DynamoDB stream as a source. +type PipeSourceDynamoDBStreamParameters struct { + _ struct{} `type:"structure"` + + // The maximum number of records to include in each batch. + BatchSize *int64 `min:"1" type:"integer"` + + // Define the target queue to send dead-letter queue events to. + DeadLetterConfig *DeadLetterConfig `type:"structure"` + + // The maximum length of a time to wait for events. + MaximumBatchingWindowInSeconds *int64 `type:"integer"` + + // (Streams only) Discard records older than the specified age. The default + // value is -1, which sets the maximum age to infinite. When the value is set + // to infinite, EventBridge never discards old records. + MaximumRecordAgeInSeconds *int64 `type:"integer"` + + // (Streams only) Discard records after the specified number of retries. The + // default value is -1, which sets the maximum number of retries to infinite. + // When MaximumRetryAttempts is infinite, EventBridge retries failed records + // until the record expires in the event source. + MaximumRetryAttempts *int64 `type:"integer"` + + // (Streams only) Define how to handle item process failures. AUTOMATIC_BISECT + // halves each batch and retry each half until all the records are processed + // or there is one failed message left in the batch. + OnPartialBatchItemFailure *string `type:"string" enum:"OnPartialBatchItemFailureStreams"` + + // (Streams only) The number of batches to process concurrently from each shard. + // The default value is 1. + ParallelizationFactor *int64 `min:"1" type:"integer"` + + // (Streams only) The position in a stream from which to start reading. + // + // StartingPosition is a required field + StartingPosition *string `type:"string" required:"true" enum:"DynamoDBStreamStartPosition"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeSourceDynamoDBStreamParameters) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeSourceDynamoDBStreamParameters) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *PipeSourceDynamoDBStreamParameters) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "PipeSourceDynamoDBStreamParameters"} + if s.BatchSize != nil && *s.BatchSize < 1 { + invalidParams.Add(request.NewErrParamMinValue("BatchSize", 1)) + } + if s.MaximumRecordAgeInSeconds != nil && *s.MaximumRecordAgeInSeconds < -1 { + invalidParams.Add(request.NewErrParamMinValue("MaximumRecordAgeInSeconds", -1)) + } + if s.MaximumRetryAttempts != nil && *s.MaximumRetryAttempts < -1 { + invalidParams.Add(request.NewErrParamMinValue("MaximumRetryAttempts", -1)) + } + if s.ParallelizationFactor != nil && *s.ParallelizationFactor < 1 { + invalidParams.Add(request.NewErrParamMinValue("ParallelizationFactor", 1)) + } + if s.StartingPosition == nil { + invalidParams.Add(request.NewErrParamRequired("StartingPosition")) + } + if s.DeadLetterConfig != nil { + if err := s.DeadLetterConfig.Validate(); err != nil { + invalidParams.AddNested("DeadLetterConfig", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBatchSize sets the BatchSize field's value. +func (s *PipeSourceDynamoDBStreamParameters) SetBatchSize(v int64) *PipeSourceDynamoDBStreamParameters { + s.BatchSize = &v + return s +} + +// SetDeadLetterConfig sets the DeadLetterConfig field's value. +func (s *PipeSourceDynamoDBStreamParameters) SetDeadLetterConfig(v *DeadLetterConfig) *PipeSourceDynamoDBStreamParameters { + s.DeadLetterConfig = v + return s +} + +// SetMaximumBatchingWindowInSeconds sets the MaximumBatchingWindowInSeconds field's value. +func (s *PipeSourceDynamoDBStreamParameters) SetMaximumBatchingWindowInSeconds(v int64) *PipeSourceDynamoDBStreamParameters { + s.MaximumBatchingWindowInSeconds = &v + return s +} + +// SetMaximumRecordAgeInSeconds sets the MaximumRecordAgeInSeconds field's value. +func (s *PipeSourceDynamoDBStreamParameters) SetMaximumRecordAgeInSeconds(v int64) *PipeSourceDynamoDBStreamParameters { + s.MaximumRecordAgeInSeconds = &v + return s +} + +// SetMaximumRetryAttempts sets the MaximumRetryAttempts field's value. +func (s *PipeSourceDynamoDBStreamParameters) SetMaximumRetryAttempts(v int64) *PipeSourceDynamoDBStreamParameters { + s.MaximumRetryAttempts = &v + return s +} + +// SetOnPartialBatchItemFailure sets the OnPartialBatchItemFailure field's value. +func (s *PipeSourceDynamoDBStreamParameters) SetOnPartialBatchItemFailure(v string) *PipeSourceDynamoDBStreamParameters { + s.OnPartialBatchItemFailure = &v + return s +} + +// SetParallelizationFactor sets the ParallelizationFactor field's value. +func (s *PipeSourceDynamoDBStreamParameters) SetParallelizationFactor(v int64) *PipeSourceDynamoDBStreamParameters { + s.ParallelizationFactor = &v + return s +} + +// SetStartingPosition sets the StartingPosition field's value. +func (s *PipeSourceDynamoDBStreamParameters) SetStartingPosition(v string) *PipeSourceDynamoDBStreamParameters { + s.StartingPosition = &v + return s +} + +// The parameters for using a Kinesis stream as a source. +type PipeSourceKinesisStreamParameters struct { + _ struct{} `type:"structure"` + + // The maximum number of records to include in each batch. + BatchSize *int64 `min:"1" type:"integer"` + + // Define the target queue to send dead-letter queue events to. + DeadLetterConfig *DeadLetterConfig `type:"structure"` + + // The maximum length of a time to wait for events. + MaximumBatchingWindowInSeconds *int64 `type:"integer"` + + // (Streams only) Discard records older than the specified age. The default + // value is -1, which sets the maximum age to infinite. When the value is set + // to infinite, EventBridge never discards old records. + MaximumRecordAgeInSeconds *int64 `type:"integer"` + + // (Streams only) Discard records after the specified number of retries. The + // default value is -1, which sets the maximum number of retries to infinite. + // When MaximumRetryAttempts is infinite, EventBridge retries failed records + // until the record expires in the event source. + MaximumRetryAttempts *int64 `type:"integer"` + + // (Streams only) Define how to handle item process failures. AUTOMATIC_BISECT + // halves each batch and retry each half until all the records are processed + // or there is one failed message left in the batch. + OnPartialBatchItemFailure *string `type:"string" enum:"OnPartialBatchItemFailureStreams"` + + // (Streams only) The number of batches to process concurrently from each shard. + // The default value is 1. + ParallelizationFactor *int64 `min:"1" type:"integer"` + + // (Streams only) The position in a stream from which to start reading. + // + // StartingPosition is a required field + StartingPosition *string `type:"string" required:"true" enum:"KinesisStreamStartPosition"` + + // With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, + // in Unix time seconds. + StartingPositionTimestamp *time.Time `type:"timestamp"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeSourceKinesisStreamParameters) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeSourceKinesisStreamParameters) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *PipeSourceKinesisStreamParameters) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "PipeSourceKinesisStreamParameters"} + if s.BatchSize != nil && *s.BatchSize < 1 { + invalidParams.Add(request.NewErrParamMinValue("BatchSize", 1)) + } + if s.MaximumRecordAgeInSeconds != nil && *s.MaximumRecordAgeInSeconds < -1 { + invalidParams.Add(request.NewErrParamMinValue("MaximumRecordAgeInSeconds", -1)) + } + if s.MaximumRetryAttempts != nil && *s.MaximumRetryAttempts < -1 { + invalidParams.Add(request.NewErrParamMinValue("MaximumRetryAttempts", -1)) + } + if s.ParallelizationFactor != nil && *s.ParallelizationFactor < 1 { + invalidParams.Add(request.NewErrParamMinValue("ParallelizationFactor", 1)) + } + if s.StartingPosition == nil { + invalidParams.Add(request.NewErrParamRequired("StartingPosition")) + } + if s.DeadLetterConfig != nil { + if err := s.DeadLetterConfig.Validate(); err != nil { + invalidParams.AddNested("DeadLetterConfig", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBatchSize sets the BatchSize field's value. +func (s *PipeSourceKinesisStreamParameters) SetBatchSize(v int64) *PipeSourceKinesisStreamParameters { + s.BatchSize = &v + return s +} + +// SetDeadLetterConfig sets the DeadLetterConfig field's value. +func (s *PipeSourceKinesisStreamParameters) SetDeadLetterConfig(v *DeadLetterConfig) *PipeSourceKinesisStreamParameters { + s.DeadLetterConfig = v + return s +} + +// SetMaximumBatchingWindowInSeconds sets the MaximumBatchingWindowInSeconds field's value. +func (s *PipeSourceKinesisStreamParameters) SetMaximumBatchingWindowInSeconds(v int64) *PipeSourceKinesisStreamParameters { + s.MaximumBatchingWindowInSeconds = &v + return s +} + +// SetMaximumRecordAgeInSeconds sets the MaximumRecordAgeInSeconds field's value. +func (s *PipeSourceKinesisStreamParameters) SetMaximumRecordAgeInSeconds(v int64) *PipeSourceKinesisStreamParameters { + s.MaximumRecordAgeInSeconds = &v + return s +} + +// SetMaximumRetryAttempts sets the MaximumRetryAttempts field's value. +func (s *PipeSourceKinesisStreamParameters) SetMaximumRetryAttempts(v int64) *PipeSourceKinesisStreamParameters { + s.MaximumRetryAttempts = &v + return s +} + +// SetOnPartialBatchItemFailure sets the OnPartialBatchItemFailure field's value. +func (s *PipeSourceKinesisStreamParameters) SetOnPartialBatchItemFailure(v string) *PipeSourceKinesisStreamParameters { + s.OnPartialBatchItemFailure = &v + return s +} + +// SetParallelizationFactor sets the ParallelizationFactor field's value. +func (s *PipeSourceKinesisStreamParameters) SetParallelizationFactor(v int64) *PipeSourceKinesisStreamParameters { + s.ParallelizationFactor = &v + return s +} + +// SetStartingPosition sets the StartingPosition field's value. +func (s *PipeSourceKinesisStreamParameters) SetStartingPosition(v string) *PipeSourceKinesisStreamParameters { + s.StartingPosition = &v + return s +} + +// SetStartingPositionTimestamp sets the StartingPositionTimestamp field's value. +func (s *PipeSourceKinesisStreamParameters) SetStartingPositionTimestamp(v time.Time) *PipeSourceKinesisStreamParameters { + s.StartingPositionTimestamp = &v + return s +} + +// The parameters for using an MSK stream as a source. +type PipeSourceManagedStreamingKafkaParameters struct { + _ struct{} `type:"structure"` + + // The maximum number of records to include in each batch. + BatchSize *int64 `min:"1" type:"integer"` + + // The name of the destination queue to consume. + // + // ConsumerGroupID is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by PipeSourceManagedStreamingKafkaParameters's + // String and GoString methods. + ConsumerGroupID *string `min:"1" type:"string" sensitive:"true"` + + // The credentials needed to access the resource. + Credentials *MSKAccessCredentials `type:"structure"` + + // The maximum length of a time to wait for events. + MaximumBatchingWindowInSeconds *int64 `type:"integer"` + + // (Streams only) The position in a stream from which to start reading. + StartingPosition *string `type:"string" enum:"MSKStartPosition"` + + // The name of the topic that the pipe will read from. + // + // TopicName is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by PipeSourceManagedStreamingKafkaParameters's + // String and GoString methods. + // + // TopicName is a required field + TopicName *string `min:"1" type:"string" required:"true" sensitive:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeSourceManagedStreamingKafkaParameters) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeSourceManagedStreamingKafkaParameters) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *PipeSourceManagedStreamingKafkaParameters) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "PipeSourceManagedStreamingKafkaParameters"} + if s.BatchSize != nil && *s.BatchSize < 1 { + invalidParams.Add(request.NewErrParamMinValue("BatchSize", 1)) + } + if s.ConsumerGroupID != nil && len(*s.ConsumerGroupID) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ConsumerGroupID", 1)) + } + if s.TopicName == nil { + invalidParams.Add(request.NewErrParamRequired("TopicName")) + } + if s.TopicName != nil && len(*s.TopicName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TopicName", 1)) + } + if s.Credentials != nil { + if err := s.Credentials.Validate(); err != nil { + invalidParams.AddNested("Credentials", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBatchSize sets the BatchSize field's value. +func (s *PipeSourceManagedStreamingKafkaParameters) SetBatchSize(v int64) *PipeSourceManagedStreamingKafkaParameters { + s.BatchSize = &v + return s +} + +// SetConsumerGroupID sets the ConsumerGroupID field's value. +func (s *PipeSourceManagedStreamingKafkaParameters) SetConsumerGroupID(v string) *PipeSourceManagedStreamingKafkaParameters { + s.ConsumerGroupID = &v + return s +} + +// SetCredentials sets the Credentials field's value. +func (s *PipeSourceManagedStreamingKafkaParameters) SetCredentials(v *MSKAccessCredentials) *PipeSourceManagedStreamingKafkaParameters { + s.Credentials = v + return s +} + +// SetMaximumBatchingWindowInSeconds sets the MaximumBatchingWindowInSeconds field's value. +func (s *PipeSourceManagedStreamingKafkaParameters) SetMaximumBatchingWindowInSeconds(v int64) *PipeSourceManagedStreamingKafkaParameters { + s.MaximumBatchingWindowInSeconds = &v + return s +} + +// SetStartingPosition sets the StartingPosition field's value. +func (s *PipeSourceManagedStreamingKafkaParameters) SetStartingPosition(v string) *PipeSourceManagedStreamingKafkaParameters { + s.StartingPosition = &v + return s +} + +// SetTopicName sets the TopicName field's value. +func (s *PipeSourceManagedStreamingKafkaParameters) SetTopicName(v string) *PipeSourceManagedStreamingKafkaParameters { + s.TopicName = &v + return s +} + +// The parameters required to set up a source for your pipe. +type PipeSourceParameters struct { + _ struct{} `type:"structure"` + + // The parameters for using an Active MQ broker as a source. + ActiveMQBrokerParameters *PipeSourceActiveMQBrokerParameters `type:"structure"` + + // The parameters for using a DynamoDB stream as a source. + DynamoDBStreamParameters *PipeSourceDynamoDBStreamParameters `type:"structure"` + + // The collection of event patterns used to filter events. For more information, + // see Events and Event Patterns (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) + // in the Amazon EventBridge User Guide. + FilterCriteria *FilterCriteria `type:"structure"` + + // The parameters for using a Kinesis stream as a source. + KinesisStreamParameters *PipeSourceKinesisStreamParameters `type:"structure"` + + // The parameters for using an MSK stream as a source. + ManagedStreamingKafkaParameters *PipeSourceManagedStreamingKafkaParameters `type:"structure"` + + // The parameters for using a Rabbit MQ broker as a source. + RabbitMQBrokerParameters *PipeSourceRabbitMQBrokerParameters `type:"structure"` + + // The parameters for using a self-managed Apache Kafka stream as a source. + SelfManagedKafkaParameters *PipeSourceSelfManagedKafkaParameters `type:"structure"` + + // The parameters for using a Amazon SQS stream as a source. + SqsQueueParameters *PipeSourceSqsQueueParameters `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeSourceParameters) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeSourceParameters) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *PipeSourceParameters) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "PipeSourceParameters"} + if s.ActiveMQBrokerParameters != nil { + if err := s.ActiveMQBrokerParameters.Validate(); err != nil { + invalidParams.AddNested("ActiveMQBrokerParameters", err.(request.ErrInvalidParams)) + } + } + if s.DynamoDBStreamParameters != nil { + if err := s.DynamoDBStreamParameters.Validate(); err != nil { + invalidParams.AddNested("DynamoDBStreamParameters", err.(request.ErrInvalidParams)) + } + } + if s.KinesisStreamParameters != nil { + if err := s.KinesisStreamParameters.Validate(); err != nil { + invalidParams.AddNested("KinesisStreamParameters", err.(request.ErrInvalidParams)) + } + } + if s.ManagedStreamingKafkaParameters != nil { + if err := s.ManagedStreamingKafkaParameters.Validate(); err != nil { + invalidParams.AddNested("ManagedStreamingKafkaParameters", err.(request.ErrInvalidParams)) + } + } + if s.RabbitMQBrokerParameters != nil { + if err := s.RabbitMQBrokerParameters.Validate(); err != nil { + invalidParams.AddNested("RabbitMQBrokerParameters", err.(request.ErrInvalidParams)) + } + } + if s.SelfManagedKafkaParameters != nil { + if err := s.SelfManagedKafkaParameters.Validate(); err != nil { + invalidParams.AddNested("SelfManagedKafkaParameters", err.(request.ErrInvalidParams)) + } + } + if s.SqsQueueParameters != nil { + if err := s.SqsQueueParameters.Validate(); err != nil { + invalidParams.AddNested("SqsQueueParameters", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetActiveMQBrokerParameters sets the ActiveMQBrokerParameters field's value. +func (s *PipeSourceParameters) SetActiveMQBrokerParameters(v *PipeSourceActiveMQBrokerParameters) *PipeSourceParameters { + s.ActiveMQBrokerParameters = v + return s +} + +// SetDynamoDBStreamParameters sets the DynamoDBStreamParameters field's value. +func (s *PipeSourceParameters) SetDynamoDBStreamParameters(v *PipeSourceDynamoDBStreamParameters) *PipeSourceParameters { + s.DynamoDBStreamParameters = v + return s +} + +// SetFilterCriteria sets the FilterCriteria field's value. +func (s *PipeSourceParameters) SetFilterCriteria(v *FilterCriteria) *PipeSourceParameters { + s.FilterCriteria = v + return s +} + +// SetKinesisStreamParameters sets the KinesisStreamParameters field's value. +func (s *PipeSourceParameters) SetKinesisStreamParameters(v *PipeSourceKinesisStreamParameters) *PipeSourceParameters { + s.KinesisStreamParameters = v + return s +} + +// SetManagedStreamingKafkaParameters sets the ManagedStreamingKafkaParameters field's value. +func (s *PipeSourceParameters) SetManagedStreamingKafkaParameters(v *PipeSourceManagedStreamingKafkaParameters) *PipeSourceParameters { + s.ManagedStreamingKafkaParameters = v + return s +} + +// SetRabbitMQBrokerParameters sets the RabbitMQBrokerParameters field's value. +func (s *PipeSourceParameters) SetRabbitMQBrokerParameters(v *PipeSourceRabbitMQBrokerParameters) *PipeSourceParameters { + s.RabbitMQBrokerParameters = v + return s +} + +// SetSelfManagedKafkaParameters sets the SelfManagedKafkaParameters field's value. +func (s *PipeSourceParameters) SetSelfManagedKafkaParameters(v *PipeSourceSelfManagedKafkaParameters) *PipeSourceParameters { + s.SelfManagedKafkaParameters = v + return s +} + +// SetSqsQueueParameters sets the SqsQueueParameters field's value. +func (s *PipeSourceParameters) SetSqsQueueParameters(v *PipeSourceSqsQueueParameters) *PipeSourceParameters { + s.SqsQueueParameters = v + return s +} + +// The parameters for using a Rabbit MQ broker as a source. +type PipeSourceRabbitMQBrokerParameters struct { + _ struct{} `type:"structure"` + + // The maximum number of records to include in each batch. + BatchSize *int64 `min:"1" type:"integer"` + + // The credentials needed to access the resource. + // + // Credentials is a required field + Credentials *MQBrokerAccessCredentials `type:"structure" required:"true"` + + // The maximum length of a time to wait for events. + MaximumBatchingWindowInSeconds *int64 `type:"integer"` + + // The name of the destination queue to consume. + // + // QueueName is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by PipeSourceRabbitMQBrokerParameters's + // String and GoString methods. + // + // QueueName is a required field + QueueName *string `min:"1" type:"string" required:"true" sensitive:"true"` + + // The name of the virtual host associated with the source broker. + // + // VirtualHost is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by PipeSourceRabbitMQBrokerParameters's + // String and GoString methods. + VirtualHost *string `min:"1" type:"string" sensitive:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeSourceRabbitMQBrokerParameters) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeSourceRabbitMQBrokerParameters) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *PipeSourceRabbitMQBrokerParameters) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "PipeSourceRabbitMQBrokerParameters"} + if s.BatchSize != nil && *s.BatchSize < 1 { + invalidParams.Add(request.NewErrParamMinValue("BatchSize", 1)) + } + if s.Credentials == nil { + invalidParams.Add(request.NewErrParamRequired("Credentials")) + } + if s.QueueName == nil { + invalidParams.Add(request.NewErrParamRequired("QueueName")) + } + if s.QueueName != nil && len(*s.QueueName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("QueueName", 1)) + } + if s.VirtualHost != nil && len(*s.VirtualHost) < 1 { + invalidParams.Add(request.NewErrParamMinLen("VirtualHost", 1)) + } + if s.Credentials != nil { + if err := s.Credentials.Validate(); err != nil { + invalidParams.AddNested("Credentials", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBatchSize sets the BatchSize field's value. +func (s *PipeSourceRabbitMQBrokerParameters) SetBatchSize(v int64) *PipeSourceRabbitMQBrokerParameters { + s.BatchSize = &v + return s +} + +// SetCredentials sets the Credentials field's value. +func (s *PipeSourceRabbitMQBrokerParameters) SetCredentials(v *MQBrokerAccessCredentials) *PipeSourceRabbitMQBrokerParameters { + s.Credentials = v + return s +} + +// SetMaximumBatchingWindowInSeconds sets the MaximumBatchingWindowInSeconds field's value. +func (s *PipeSourceRabbitMQBrokerParameters) SetMaximumBatchingWindowInSeconds(v int64) *PipeSourceRabbitMQBrokerParameters { + s.MaximumBatchingWindowInSeconds = &v + return s +} + +// SetQueueName sets the QueueName field's value. +func (s *PipeSourceRabbitMQBrokerParameters) SetQueueName(v string) *PipeSourceRabbitMQBrokerParameters { + s.QueueName = &v + return s +} + +// SetVirtualHost sets the VirtualHost field's value. +func (s *PipeSourceRabbitMQBrokerParameters) SetVirtualHost(v string) *PipeSourceRabbitMQBrokerParameters { + s.VirtualHost = &v + return s +} + +// The parameters for using a self-managed Apache Kafka stream as a source. +type PipeSourceSelfManagedKafkaParameters struct { + _ struct{} `type:"structure"` + + // An array of server URLs. + AdditionalBootstrapServers []*string `type:"list"` + + // The maximum number of records to include in each batch. + BatchSize *int64 `min:"1" type:"integer"` + + // The name of the destination queue to consume. + // + // ConsumerGroupID is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by PipeSourceSelfManagedKafkaParameters's + // String and GoString methods. + ConsumerGroupID *string `min:"1" type:"string" sensitive:"true"` + + // The credentials needed to access the resource. + Credentials *SelfManagedKafkaAccessConfigurationCredentials `type:"structure"` + + // The maximum length of a time to wait for events. + MaximumBatchingWindowInSeconds *int64 `type:"integer"` + + // The ARN of the Secrets Manager secret used for certification. + ServerRootCaCertificate *string `min:"1" type:"string"` + + // (Streams only) The position in a stream from which to start reading. + StartingPosition *string `type:"string" enum:"SelfManagedKafkaStartPosition"` + + // The name of the topic that the pipe will read from. + // + // TopicName is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by PipeSourceSelfManagedKafkaParameters's + // String and GoString methods. + // + // TopicName is a required field + TopicName *string `min:"1" type:"string" required:"true" sensitive:"true"` + + // This structure specifies the VPC subnets and security groups for the stream, + // and whether a public IP address is to be used. + Vpc *SelfManagedKafkaAccessConfigurationVpc `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeSourceSelfManagedKafkaParameters) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeSourceSelfManagedKafkaParameters) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *PipeSourceSelfManagedKafkaParameters) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "PipeSourceSelfManagedKafkaParameters"} + if s.BatchSize != nil && *s.BatchSize < 1 { + invalidParams.Add(request.NewErrParamMinValue("BatchSize", 1)) + } + if s.ConsumerGroupID != nil && len(*s.ConsumerGroupID) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ConsumerGroupID", 1)) + } + if s.ServerRootCaCertificate != nil && len(*s.ServerRootCaCertificate) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ServerRootCaCertificate", 1)) + } + if s.TopicName == nil { + invalidParams.Add(request.NewErrParamRequired("TopicName")) + } + if s.TopicName != nil && len(*s.TopicName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TopicName", 1)) + } + if s.Credentials != nil { + if err := s.Credentials.Validate(); err != nil { + invalidParams.AddNested("Credentials", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAdditionalBootstrapServers sets the AdditionalBootstrapServers field's value. +func (s *PipeSourceSelfManagedKafkaParameters) SetAdditionalBootstrapServers(v []*string) *PipeSourceSelfManagedKafkaParameters { + s.AdditionalBootstrapServers = v + return s +} + +// SetBatchSize sets the BatchSize field's value. +func (s *PipeSourceSelfManagedKafkaParameters) SetBatchSize(v int64) *PipeSourceSelfManagedKafkaParameters { + s.BatchSize = &v + return s +} + +// SetConsumerGroupID sets the ConsumerGroupID field's value. +func (s *PipeSourceSelfManagedKafkaParameters) SetConsumerGroupID(v string) *PipeSourceSelfManagedKafkaParameters { + s.ConsumerGroupID = &v + return s +} + +// SetCredentials sets the Credentials field's value. +func (s *PipeSourceSelfManagedKafkaParameters) SetCredentials(v *SelfManagedKafkaAccessConfigurationCredentials) *PipeSourceSelfManagedKafkaParameters { + s.Credentials = v + return s +} + +// SetMaximumBatchingWindowInSeconds sets the MaximumBatchingWindowInSeconds field's value. +func (s *PipeSourceSelfManagedKafkaParameters) SetMaximumBatchingWindowInSeconds(v int64) *PipeSourceSelfManagedKafkaParameters { + s.MaximumBatchingWindowInSeconds = &v + return s +} + +// SetServerRootCaCertificate sets the ServerRootCaCertificate field's value. +func (s *PipeSourceSelfManagedKafkaParameters) SetServerRootCaCertificate(v string) *PipeSourceSelfManagedKafkaParameters { + s.ServerRootCaCertificate = &v + return s +} + +// SetStartingPosition sets the StartingPosition field's value. +func (s *PipeSourceSelfManagedKafkaParameters) SetStartingPosition(v string) *PipeSourceSelfManagedKafkaParameters { + s.StartingPosition = &v + return s +} + +// SetTopicName sets the TopicName field's value. +func (s *PipeSourceSelfManagedKafkaParameters) SetTopicName(v string) *PipeSourceSelfManagedKafkaParameters { + s.TopicName = &v + return s +} + +// SetVpc sets the Vpc field's value. +func (s *PipeSourceSelfManagedKafkaParameters) SetVpc(v *SelfManagedKafkaAccessConfigurationVpc) *PipeSourceSelfManagedKafkaParameters { + s.Vpc = v + return s +} + +// The parameters for using a Amazon SQS stream as a source. +type PipeSourceSqsQueueParameters struct { + _ struct{} `type:"structure"` + + // The maximum number of records to include in each batch. + BatchSize *int64 `min:"1" type:"integer"` + + // The maximum length of a time to wait for events. + MaximumBatchingWindowInSeconds *int64 `type:"integer"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeSourceSqsQueueParameters) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeSourceSqsQueueParameters) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *PipeSourceSqsQueueParameters) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "PipeSourceSqsQueueParameters"} + if s.BatchSize != nil && *s.BatchSize < 1 { + invalidParams.Add(request.NewErrParamMinValue("BatchSize", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBatchSize sets the BatchSize field's value. +func (s *PipeSourceSqsQueueParameters) SetBatchSize(v int64) *PipeSourceSqsQueueParameters { + s.BatchSize = &v + return s +} + +// SetMaximumBatchingWindowInSeconds sets the MaximumBatchingWindowInSeconds field's value. +func (s *PipeSourceSqsQueueParameters) SetMaximumBatchingWindowInSeconds(v int64) *PipeSourceSqsQueueParameters { + s.MaximumBatchingWindowInSeconds = &v + return s +} + +// The parameters for using an Batch job as a target. +type PipeTargetBatchJobParameters struct { + _ struct{} `type:"structure"` + + // The array properties for the submitted job, such as the size of the array. + // The array size can be between 2 and 10,000. If you specify array properties + // for a job, it becomes an array job. This parameter is used only if the target + // is an Batch job. + ArrayProperties *BatchArrayProperties `type:"structure"` + + // The overrides that are sent to a container. + ContainerOverrides *BatchContainerOverrides `type:"structure"` + + // A list of dependencies for the job. A job can depend upon a maximum of 20 + // jobs. You can specify a SEQUENTIAL type dependency without specifying a job + // ID for array jobs so that each child array job completes sequentially, starting + // at index 0. You can also specify an N_TO_N type dependency with a job ID + // for array jobs. In that case, each index child of this job must wait for + // the corresponding index child of each dependency to complete before it can + // begin. + DependsOn []*BatchJobDependency `type:"list"` + + // The job definition used by this job. This value can be one of name, name:revision, + // or the Amazon Resource Name (ARN) for the job definition. If name is specified + // without a revision then the latest active revision is used. + // + // JobDefinition is a required field + JobDefinition *string `type:"string" required:"true"` + + // The name of the job. It can be up to 128 letters long. The first character + // must be alphanumeric, can contain uppercase and lowercase letters, numbers, + // hyphens (-), and underscores (_). + // + // JobName is a required field + JobName *string `type:"string" required:"true"` + + // Additional parameters passed to the job that replace parameter substitution + // placeholders that are set in the job definition. Parameters are specified + // as a key and value pair mapping. Parameters included here override any corresponding + // parameter defaults from the job definition. + Parameters map[string]*string `type:"map"` + + // The retry strategy to use for failed jobs. When a retry strategy is specified + // here, it overrides the retry strategy defined in the job definition. + RetryStrategy *BatchRetryStrategy `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeTargetBatchJobParameters) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeTargetBatchJobParameters) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *PipeTargetBatchJobParameters) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "PipeTargetBatchJobParameters"} + if s.JobDefinition == nil { + invalidParams.Add(request.NewErrParamRequired("JobDefinition")) + } + if s.JobName == nil { + invalidParams.Add(request.NewErrParamRequired("JobName")) + } + if s.ArrayProperties != nil { + if err := s.ArrayProperties.Validate(); err != nil { + invalidParams.AddNested("ArrayProperties", err.(request.ErrInvalidParams)) + } + } + if s.ContainerOverrides != nil { + if err := s.ContainerOverrides.Validate(); err != nil { + invalidParams.AddNested("ContainerOverrides", err.(request.ErrInvalidParams)) + } + } + if s.RetryStrategy != nil { + if err := s.RetryStrategy.Validate(); err != nil { + invalidParams.AddNested("RetryStrategy", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetArrayProperties sets the ArrayProperties field's value. +func (s *PipeTargetBatchJobParameters) SetArrayProperties(v *BatchArrayProperties) *PipeTargetBatchJobParameters { + s.ArrayProperties = v + return s +} + +// SetContainerOverrides sets the ContainerOverrides field's value. +func (s *PipeTargetBatchJobParameters) SetContainerOverrides(v *BatchContainerOverrides) *PipeTargetBatchJobParameters { + s.ContainerOverrides = v + return s +} + +// SetDependsOn sets the DependsOn field's value. +func (s *PipeTargetBatchJobParameters) SetDependsOn(v []*BatchJobDependency) *PipeTargetBatchJobParameters { + s.DependsOn = v + return s +} + +// SetJobDefinition sets the JobDefinition field's value. +func (s *PipeTargetBatchJobParameters) SetJobDefinition(v string) *PipeTargetBatchJobParameters { + s.JobDefinition = &v + return s +} + +// SetJobName sets the JobName field's value. +func (s *PipeTargetBatchJobParameters) SetJobName(v string) *PipeTargetBatchJobParameters { + s.JobName = &v + return s +} + +// SetParameters sets the Parameters field's value. +func (s *PipeTargetBatchJobParameters) SetParameters(v map[string]*string) *PipeTargetBatchJobParameters { + s.Parameters = v + return s +} + +// SetRetryStrategy sets the RetryStrategy field's value. +func (s *PipeTargetBatchJobParameters) SetRetryStrategy(v *BatchRetryStrategy) *PipeTargetBatchJobParameters { + s.RetryStrategy = v + return s +} + +// The parameters for using an CloudWatch Logs log stream as a target. +type PipeTargetCloudWatchLogsParameters struct { + _ struct{} `type:"structure"` + + // The name of the log stream. + LogStreamName *string `min:"1" type:"string"` + + // The time the event occurred, expressed as the number of milliseconds after + // Jan 1, 1970 00:00:00 UTC. + Timestamp *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeTargetCloudWatchLogsParameters) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeTargetCloudWatchLogsParameters) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *PipeTargetCloudWatchLogsParameters) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "PipeTargetCloudWatchLogsParameters"} + if s.LogStreamName != nil && len(*s.LogStreamName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("LogStreamName", 1)) + } + if s.Timestamp != nil && len(*s.Timestamp) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Timestamp", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetLogStreamName sets the LogStreamName field's value. +func (s *PipeTargetCloudWatchLogsParameters) SetLogStreamName(v string) *PipeTargetCloudWatchLogsParameters { + s.LogStreamName = &v + return s +} + +// SetTimestamp sets the Timestamp field's value. +func (s *PipeTargetCloudWatchLogsParameters) SetTimestamp(v string) *PipeTargetCloudWatchLogsParameters { + s.Timestamp = &v + return s +} + +// The parameters for using an Amazon ECS task as a target. +type PipeTargetEcsTaskParameters struct { + _ struct{} `type:"structure"` + + // The capacity provider strategy to use for the task. + // + // If a capacityProviderStrategy is specified, the launchType parameter must + // be omitted. If no capacityProviderStrategy or launchType is specified, the + // defaultCapacityProviderStrategy for the cluster is used. + CapacityProviderStrategy []*CapacityProviderStrategyItem `type:"list"` + + // Specifies whether to enable Amazon ECS managed tags for the task. For more + // information, see Tagging Your Amazon ECS Resources (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) + // in the Amazon Elastic Container Service Developer Guide. + EnableECSManagedTags *bool `type:"boolean"` + + // Whether or not to enable the execute command functionality for the containers + // in this task. If true, this enables execute command functionality on all + // containers in the task. + EnableExecuteCommand *bool `type:"boolean"` + + // Specifies an Amazon ECS task group for the task. The maximum length is 255 + // characters. + Group *string `type:"string"` + + // Specifies the launch type on which your task is running. The launch type + // that you specify here must match one of the launch type (compatibilities) + // of the target task. The FARGATE value is supported only in the Regions where + // Fargate with Amazon ECS is supported. For more information, see Fargate on + // Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS-Fargate.html) + // in the Amazon Elastic Container Service Developer Guide. + LaunchType *string `type:"string" enum:"LaunchType"` + + // Use this structure if the Amazon ECS task uses the awsvpc network mode. This + // structure specifies the VPC subnets and security groups associated with the + // task, and whether a public IP address is to be used. This structure is required + // if LaunchType is FARGATE because the awsvpc mode is required for Fargate + // tasks. + // + // If you specify NetworkConfiguration when the target ECS task does not use + // the awsvpc network mode, the task fails. + NetworkConfiguration *NetworkConfiguration `type:"structure"` + + // The overrides that are associated with a task. + Overrides *EcsTaskOverride `type:"structure"` + + // An array of placement constraint objects to use for the task. You can specify + // up to 10 constraints per task (including constraints in the task definition + // and those specified at runtime). + PlacementConstraints []*PlacementConstraint `type:"list"` + + // The placement strategy objects to use for the task. You can specify a maximum + // of five strategy rules per task. + PlacementStrategy []*PlacementStrategy `type:"list"` + + // Specifies the platform version for the task. Specify only the numeric portion + // of the platform version, such as 1.1.0. + // + // This structure is used only if LaunchType is FARGATE. For more information + // about valid platform versions, see Fargate Platform Versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) + // in the Amazon Elastic Container Service Developer Guide. + PlatformVersion *string `type:"string"` + + // Specifies whether to propagate the tags from the task definition to the task. + // If no value is specified, the tags are not propagated. Tags can only be propagated + // to the task during task creation. To add tags to a task after task creation, + // use the TagResource API action. + PropagateTags *string `type:"string" enum:"PropagateTags"` + + // The reference ID to use for the task. + // + // ReferenceId is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by PipeTargetEcsTaskParameters's + // String and GoString methods. + ReferenceId *string `type:"string" sensitive:"true"` + + // The metadata that you apply to the task to help you categorize and organize + // them. Each tag consists of a key and an optional value, both of which you + // define. To learn more, see RunTask (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html#ECS-RunTask-request-tags) + // in the Amazon ECS API Reference. + Tags []*Tag `type:"list"` + + // The number of tasks to create based on TaskDefinition. The default is 1. + TaskCount *int64 `min:"1" type:"integer"` + + // The ARN of the task definition to use if the event target is an Amazon ECS + // task. + // + // TaskDefinitionArn is a required field + TaskDefinitionArn *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeTargetEcsTaskParameters) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeTargetEcsTaskParameters) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *PipeTargetEcsTaskParameters) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "PipeTargetEcsTaskParameters"} + if s.TaskCount != nil && *s.TaskCount < 1 { + invalidParams.Add(request.NewErrParamMinValue("TaskCount", 1)) + } + if s.TaskDefinitionArn == nil { + invalidParams.Add(request.NewErrParamRequired("TaskDefinitionArn")) + } + if s.TaskDefinitionArn != nil && len(*s.TaskDefinitionArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TaskDefinitionArn", 1)) + } + if s.CapacityProviderStrategy != nil { + for i, v := range s.CapacityProviderStrategy { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "CapacityProviderStrategy", i), err.(request.ErrInvalidParams)) + } + } + } + if s.NetworkConfiguration != nil { + if err := s.NetworkConfiguration.Validate(); err != nil { + invalidParams.AddNested("NetworkConfiguration", err.(request.ErrInvalidParams)) + } + } + if s.Overrides != nil { + if err := s.Overrides.Validate(); err != nil { + invalidParams.AddNested("Overrides", err.(request.ErrInvalidParams)) + } + } + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCapacityProviderStrategy sets the CapacityProviderStrategy field's value. +func (s *PipeTargetEcsTaskParameters) SetCapacityProviderStrategy(v []*CapacityProviderStrategyItem) *PipeTargetEcsTaskParameters { + s.CapacityProviderStrategy = v + return s +} + +// SetEnableECSManagedTags sets the EnableECSManagedTags field's value. +func (s *PipeTargetEcsTaskParameters) SetEnableECSManagedTags(v bool) *PipeTargetEcsTaskParameters { + s.EnableECSManagedTags = &v + return s +} + +// SetEnableExecuteCommand sets the EnableExecuteCommand field's value. +func (s *PipeTargetEcsTaskParameters) SetEnableExecuteCommand(v bool) *PipeTargetEcsTaskParameters { + s.EnableExecuteCommand = &v + return s +} + +// SetGroup sets the Group field's value. +func (s *PipeTargetEcsTaskParameters) SetGroup(v string) *PipeTargetEcsTaskParameters { + s.Group = &v + return s +} + +// SetLaunchType sets the LaunchType field's value. +func (s *PipeTargetEcsTaskParameters) SetLaunchType(v string) *PipeTargetEcsTaskParameters { + s.LaunchType = &v + return s +} + +// SetNetworkConfiguration sets the NetworkConfiguration field's value. +func (s *PipeTargetEcsTaskParameters) SetNetworkConfiguration(v *NetworkConfiguration) *PipeTargetEcsTaskParameters { + s.NetworkConfiguration = v + return s +} + +// SetOverrides sets the Overrides field's value. +func (s *PipeTargetEcsTaskParameters) SetOverrides(v *EcsTaskOverride) *PipeTargetEcsTaskParameters { + s.Overrides = v + return s +} + +// SetPlacementConstraints sets the PlacementConstraints field's value. +func (s *PipeTargetEcsTaskParameters) SetPlacementConstraints(v []*PlacementConstraint) *PipeTargetEcsTaskParameters { + s.PlacementConstraints = v + return s +} + +// SetPlacementStrategy sets the PlacementStrategy field's value. +func (s *PipeTargetEcsTaskParameters) SetPlacementStrategy(v []*PlacementStrategy) *PipeTargetEcsTaskParameters { + s.PlacementStrategy = v + return s +} + +// SetPlatformVersion sets the PlatformVersion field's value. +func (s *PipeTargetEcsTaskParameters) SetPlatformVersion(v string) *PipeTargetEcsTaskParameters { + s.PlatformVersion = &v + return s +} + +// SetPropagateTags sets the PropagateTags field's value. +func (s *PipeTargetEcsTaskParameters) SetPropagateTags(v string) *PipeTargetEcsTaskParameters { + s.PropagateTags = &v + return s +} + +// SetReferenceId sets the ReferenceId field's value. +func (s *PipeTargetEcsTaskParameters) SetReferenceId(v string) *PipeTargetEcsTaskParameters { + s.ReferenceId = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *PipeTargetEcsTaskParameters) SetTags(v []*Tag) *PipeTargetEcsTaskParameters { + s.Tags = v + return s +} + +// SetTaskCount sets the TaskCount field's value. +func (s *PipeTargetEcsTaskParameters) SetTaskCount(v int64) *PipeTargetEcsTaskParameters { + s.TaskCount = &v + return s +} + +// SetTaskDefinitionArn sets the TaskDefinitionArn field's value. +func (s *PipeTargetEcsTaskParameters) SetTaskDefinitionArn(v string) *PipeTargetEcsTaskParameters { + s.TaskDefinitionArn = &v + return s +} + +// The parameters for using an EventBridge event bus as a target. +type PipeTargetEventBridgeEventBusParameters struct { + _ struct{} `type:"structure"` + + // A free-form string, with a maximum of 128 characters, used to decide what + // fields to expect in the event detail. + // + // DetailType is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by PipeTargetEventBridgeEventBusParameters's + // String and GoString methods. + DetailType *string `min:"1" type:"string" sensitive:"true"` + + // The URL subdomain of the endpoint. For example, if the URL for Endpoint is + // https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo. + // + // When using Java, you must include auth-crt on the class path. + // + // EndpointId is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by PipeTargetEventBridgeEventBusParameters's + // String and GoString methods. + EndpointId *string `min:"1" type:"string" sensitive:"true"` + + // Amazon Web Services resources, identified by Amazon Resource Name (ARN), + // which the event primarily concerns. Any number, including zero, may be present. + Resources []*string `type:"list"` + + // The source of the event. + // + // Source is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by PipeTargetEventBridgeEventBusParameters's + // String and GoString methods. + Source *string `min:"1" type:"string" sensitive:"true"` + + // The time stamp of the event, per RFC3339 (https://www.rfc-editor.org/rfc/rfc3339.txt). + // If no time stamp is provided, the time stamp of the PutEvents (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html) + // call is used. + Time *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeTargetEventBridgeEventBusParameters) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeTargetEventBridgeEventBusParameters) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *PipeTargetEventBridgeEventBusParameters) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "PipeTargetEventBridgeEventBusParameters"} + if s.DetailType != nil && len(*s.DetailType) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DetailType", 1)) + } + if s.EndpointId != nil && len(*s.EndpointId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("EndpointId", 1)) + } + if s.Source != nil && len(*s.Source) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Source", 1)) + } + if s.Time != nil && len(*s.Time) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Time", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDetailType sets the DetailType field's value. +func (s *PipeTargetEventBridgeEventBusParameters) SetDetailType(v string) *PipeTargetEventBridgeEventBusParameters { + s.DetailType = &v + return s +} + +// SetEndpointId sets the EndpointId field's value. +func (s *PipeTargetEventBridgeEventBusParameters) SetEndpointId(v string) *PipeTargetEventBridgeEventBusParameters { + s.EndpointId = &v + return s +} + +// SetResources sets the Resources field's value. +func (s *PipeTargetEventBridgeEventBusParameters) SetResources(v []*string) *PipeTargetEventBridgeEventBusParameters { + s.Resources = v + return s +} + +// SetSource sets the Source field's value. +func (s *PipeTargetEventBridgeEventBusParameters) SetSource(v string) *PipeTargetEventBridgeEventBusParameters { + s.Source = &v + return s +} + +// SetTime sets the Time field's value. +func (s *PipeTargetEventBridgeEventBusParameters) SetTime(v string) *PipeTargetEventBridgeEventBusParameters { + s.Time = &v + return s +} + +// These are custom parameter to be used when the target is an API Gateway REST +// APIs or EventBridge ApiDestinations. +type PipeTargetHttpParameters struct { + _ struct{} `type:"structure"` + + // The headers that need to be sent as part of request invoking the API Gateway + // REST API or EventBridge ApiDestination. + HeaderParameters map[string]*string `type:"map"` + + // The path parameter values to be used to populate API Gateway REST API or + // EventBridge ApiDestination path wildcards ("*"). + PathParameterValues []*string `type:"list"` + + // The query string keys/values that need to be sent as part of request invoking + // the API Gateway REST API or EventBridge ApiDestination. + QueryStringParameters map[string]*string `type:"map"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeTargetHttpParameters) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeTargetHttpParameters) GoString() string { + return s.String() +} + +// SetHeaderParameters sets the HeaderParameters field's value. +func (s *PipeTargetHttpParameters) SetHeaderParameters(v map[string]*string) *PipeTargetHttpParameters { + s.HeaderParameters = v + return s +} + +// SetPathParameterValues sets the PathParameterValues field's value. +func (s *PipeTargetHttpParameters) SetPathParameterValues(v []*string) *PipeTargetHttpParameters { + s.PathParameterValues = v + return s +} + +// SetQueryStringParameters sets the QueryStringParameters field's value. +func (s *PipeTargetHttpParameters) SetQueryStringParameters(v map[string]*string) *PipeTargetHttpParameters { + s.QueryStringParameters = v + return s +} + +// The parameters for using a Kinesis stream as a source. +type PipeTargetKinesisStreamParameters struct { + _ struct{} `type:"structure"` + + // Determines which shard in the stream the data record is assigned to. Partition + // keys are Unicode strings with a maximum length limit of 256 characters for + // each key. Amazon Kinesis Data Streams uses the partition key as input to + // a hash function that maps the partition key and associated data to a specific + // shard. Specifically, an MD5 hash function is used to map partition keys to + // 128-bit integer values and to map associated data records to shards. As a + // result of this hashing mechanism, all data records with the same partition + // key map to the same shard within the stream. + // + // PartitionKey is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by PipeTargetKinesisStreamParameters's + // String and GoString methods. + // + // PartitionKey is a required field + PartitionKey *string `type:"string" required:"true" sensitive:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeTargetKinesisStreamParameters) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeTargetKinesisStreamParameters) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *PipeTargetKinesisStreamParameters) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "PipeTargetKinesisStreamParameters"} + if s.PartitionKey == nil { + invalidParams.Add(request.NewErrParamRequired("PartitionKey")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetPartitionKey sets the PartitionKey field's value. +func (s *PipeTargetKinesisStreamParameters) SetPartitionKey(v string) *PipeTargetKinesisStreamParameters { + s.PartitionKey = &v + return s +} + +// The parameters for using a Lambda function as a target. +type PipeTargetLambdaFunctionParameters struct { + _ struct{} `type:"structure"` + + // Choose from the following options. + // + // * RequestResponse (default) - Invoke the function synchronously. Keep + // the connection open until the function returns a response or times out. + // The API response includes the function response and additional data. + // + // * Event - Invoke the function asynchronously. Send events that fail multiple + // times to the function's dead-letter queue (if it's configured). The API + // response only includes a status code. + // + // * DryRun - Validate parameter values and verify that the user or role + // has permission to invoke the function. + InvocationType *string `type:"string" enum:"PipeTargetInvocationType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeTargetLambdaFunctionParameters) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeTargetLambdaFunctionParameters) GoString() string { + return s.String() +} + +// SetInvocationType sets the InvocationType field's value. +func (s *PipeTargetLambdaFunctionParameters) SetInvocationType(v string) *PipeTargetLambdaFunctionParameters { + s.InvocationType = &v + return s +} + +// The parameters required to set up a target for your pipe. +type PipeTargetParameters struct { + _ struct{} `type:"structure"` + + // The parameters for using an Batch job as a target. + BatchJobParameters *PipeTargetBatchJobParameters `type:"structure"` + + // The parameters for using an CloudWatch Logs log stream as a target. + CloudWatchLogsParameters *PipeTargetCloudWatchLogsParameters `type:"structure"` + + // The parameters for using an Amazon ECS task as a target. + EcsTaskParameters *PipeTargetEcsTaskParameters `type:"structure"` + + // The parameters for using an EventBridge event bus as a target. + EventBridgeEventBusParameters *PipeTargetEventBridgeEventBusParameters `type:"structure"` + + // These are custom parameter to be used when the target is an API Gateway REST + // APIs or EventBridge ApiDestinations. + HttpParameters *PipeTargetHttpParameters `type:"structure"` + + // Valid JSON text passed to the target. In this case, nothing from the event + // itself is passed to the target. For more information, see The JavaScript + // Object Notation (JSON) Data Interchange Format (http://www.rfc-editor.org/rfc/rfc7159.txt). + // + // InputTemplate is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by PipeTargetParameters's + // String and GoString methods. + InputTemplate *string `type:"string" sensitive:"true"` + + // The parameters for using a Kinesis stream as a source. + KinesisStreamParameters *PipeTargetKinesisStreamParameters `type:"structure"` + + // The parameters for using a Lambda function as a target. + LambdaFunctionParameters *PipeTargetLambdaFunctionParameters `type:"structure"` + + // These are custom parameters to be used when the target is a Amazon Redshift + // cluster to invoke the Amazon Redshift Data API ExecuteStatement. + RedshiftDataParameters *PipeTargetRedshiftDataParameters `type:"structure"` + + // The parameters for using a SageMaker pipeline as a target. + SageMakerPipelineParameters *PipeTargetSageMakerPipelineParameters `type:"structure"` + + // The parameters for using a Amazon SQS stream as a source. + SqsQueueParameters *PipeTargetSqsQueueParameters `type:"structure"` + + // The parameters for using a Step Functions state machine as a target. + StepFunctionStateMachineParameters *PipeTargetStateMachineParameters `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeTargetParameters) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeTargetParameters) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *PipeTargetParameters) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "PipeTargetParameters"} + if s.BatchJobParameters != nil { + if err := s.BatchJobParameters.Validate(); err != nil { + invalidParams.AddNested("BatchJobParameters", err.(request.ErrInvalidParams)) + } + } + if s.CloudWatchLogsParameters != nil { + if err := s.CloudWatchLogsParameters.Validate(); err != nil { + invalidParams.AddNested("CloudWatchLogsParameters", err.(request.ErrInvalidParams)) + } + } + if s.EcsTaskParameters != nil { + if err := s.EcsTaskParameters.Validate(); err != nil { + invalidParams.AddNested("EcsTaskParameters", err.(request.ErrInvalidParams)) + } + } + if s.EventBridgeEventBusParameters != nil { + if err := s.EventBridgeEventBusParameters.Validate(); err != nil { + invalidParams.AddNested("EventBridgeEventBusParameters", err.(request.ErrInvalidParams)) + } + } + if s.KinesisStreamParameters != nil { + if err := s.KinesisStreamParameters.Validate(); err != nil { + invalidParams.AddNested("KinesisStreamParameters", err.(request.ErrInvalidParams)) + } + } + if s.RedshiftDataParameters != nil { + if err := s.RedshiftDataParameters.Validate(); err != nil { + invalidParams.AddNested("RedshiftDataParameters", err.(request.ErrInvalidParams)) + } + } + if s.SageMakerPipelineParameters != nil { + if err := s.SageMakerPipelineParameters.Validate(); err != nil { + invalidParams.AddNested("SageMakerPipelineParameters", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBatchJobParameters sets the BatchJobParameters field's value. +func (s *PipeTargetParameters) SetBatchJobParameters(v *PipeTargetBatchJobParameters) *PipeTargetParameters { + s.BatchJobParameters = v + return s +} + +// SetCloudWatchLogsParameters sets the CloudWatchLogsParameters field's value. +func (s *PipeTargetParameters) SetCloudWatchLogsParameters(v *PipeTargetCloudWatchLogsParameters) *PipeTargetParameters { + s.CloudWatchLogsParameters = v + return s +} + +// SetEcsTaskParameters sets the EcsTaskParameters field's value. +func (s *PipeTargetParameters) SetEcsTaskParameters(v *PipeTargetEcsTaskParameters) *PipeTargetParameters { + s.EcsTaskParameters = v + return s +} + +// SetEventBridgeEventBusParameters sets the EventBridgeEventBusParameters field's value. +func (s *PipeTargetParameters) SetEventBridgeEventBusParameters(v *PipeTargetEventBridgeEventBusParameters) *PipeTargetParameters { + s.EventBridgeEventBusParameters = v + return s +} + +// SetHttpParameters sets the HttpParameters field's value. +func (s *PipeTargetParameters) SetHttpParameters(v *PipeTargetHttpParameters) *PipeTargetParameters { + s.HttpParameters = v + return s +} + +// SetInputTemplate sets the InputTemplate field's value. +func (s *PipeTargetParameters) SetInputTemplate(v string) *PipeTargetParameters { + s.InputTemplate = &v + return s +} + +// SetKinesisStreamParameters sets the KinesisStreamParameters field's value. +func (s *PipeTargetParameters) SetKinesisStreamParameters(v *PipeTargetKinesisStreamParameters) *PipeTargetParameters { + s.KinesisStreamParameters = v + return s +} + +// SetLambdaFunctionParameters sets the LambdaFunctionParameters field's value. +func (s *PipeTargetParameters) SetLambdaFunctionParameters(v *PipeTargetLambdaFunctionParameters) *PipeTargetParameters { + s.LambdaFunctionParameters = v + return s +} + +// SetRedshiftDataParameters sets the RedshiftDataParameters field's value. +func (s *PipeTargetParameters) SetRedshiftDataParameters(v *PipeTargetRedshiftDataParameters) *PipeTargetParameters { + s.RedshiftDataParameters = v + return s +} + +// SetSageMakerPipelineParameters sets the SageMakerPipelineParameters field's value. +func (s *PipeTargetParameters) SetSageMakerPipelineParameters(v *PipeTargetSageMakerPipelineParameters) *PipeTargetParameters { + s.SageMakerPipelineParameters = v + return s +} + +// SetSqsQueueParameters sets the SqsQueueParameters field's value. +func (s *PipeTargetParameters) SetSqsQueueParameters(v *PipeTargetSqsQueueParameters) *PipeTargetParameters { + s.SqsQueueParameters = v + return s +} + +// SetStepFunctionStateMachineParameters sets the StepFunctionStateMachineParameters field's value. +func (s *PipeTargetParameters) SetStepFunctionStateMachineParameters(v *PipeTargetStateMachineParameters) *PipeTargetParameters { + s.StepFunctionStateMachineParameters = v + return s +} + +// These are custom parameters to be used when the target is a Amazon Redshift +// cluster to invoke the Amazon Redshift Data API ExecuteStatement. +type PipeTargetRedshiftDataParameters struct { + _ struct{} `type:"structure"` + + // The name of the database. Required when authenticating using temporary credentials. + // + // Database is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by PipeTargetRedshiftDataParameters's + // String and GoString methods. + // + // Database is a required field + Database *string `min:"1" type:"string" required:"true" sensitive:"true"` + + // The database user name. Required when authenticating using temporary credentials. + // + // DbUser is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by PipeTargetRedshiftDataParameters's + // String and GoString methods. + DbUser *string `min:"1" type:"string" sensitive:"true"` + + // The name or ARN of the secret that enables access to the database. Required + // when authenticating using SageMaker. + SecretManagerArn *string `min:"1" type:"string"` + + // The SQL statement text to run. + // + // Sqls is a required field + Sqls []*string `min:"1" type:"list" required:"true"` + + // The name of the SQL statement. You can name the SQL statement when you create + // it to identify the query. + // + // StatementName is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by PipeTargetRedshiftDataParameters's + // String and GoString methods. + StatementName *string `min:"1" type:"string" sensitive:"true"` + + // Indicates whether to send an event back to EventBridge after the SQL statement + // runs. + WithEvent *bool `type:"boolean"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeTargetRedshiftDataParameters) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeTargetRedshiftDataParameters) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *PipeTargetRedshiftDataParameters) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "PipeTargetRedshiftDataParameters"} + if s.Database == nil { + invalidParams.Add(request.NewErrParamRequired("Database")) + } + if s.Database != nil && len(*s.Database) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Database", 1)) + } + if s.DbUser != nil && len(*s.DbUser) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DbUser", 1)) + } + if s.SecretManagerArn != nil && len(*s.SecretManagerArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("SecretManagerArn", 1)) + } + if s.Sqls == nil { + invalidParams.Add(request.NewErrParamRequired("Sqls")) + } + if s.Sqls != nil && len(s.Sqls) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Sqls", 1)) + } + if s.StatementName != nil && len(*s.StatementName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("StatementName", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDatabase sets the Database field's value. +func (s *PipeTargetRedshiftDataParameters) SetDatabase(v string) *PipeTargetRedshiftDataParameters { + s.Database = &v + return s +} + +// SetDbUser sets the DbUser field's value. +func (s *PipeTargetRedshiftDataParameters) SetDbUser(v string) *PipeTargetRedshiftDataParameters { + s.DbUser = &v + return s +} + +// SetSecretManagerArn sets the SecretManagerArn field's value. +func (s *PipeTargetRedshiftDataParameters) SetSecretManagerArn(v string) *PipeTargetRedshiftDataParameters { + s.SecretManagerArn = &v + return s +} + +// SetSqls sets the Sqls field's value. +func (s *PipeTargetRedshiftDataParameters) SetSqls(v []*string) *PipeTargetRedshiftDataParameters { + s.Sqls = v + return s +} + +// SetStatementName sets the StatementName field's value. +func (s *PipeTargetRedshiftDataParameters) SetStatementName(v string) *PipeTargetRedshiftDataParameters { + s.StatementName = &v + return s +} + +// SetWithEvent sets the WithEvent field's value. +func (s *PipeTargetRedshiftDataParameters) SetWithEvent(v bool) *PipeTargetRedshiftDataParameters { + s.WithEvent = &v + return s +} + +// The parameters for using a SageMaker pipeline as a target. +type PipeTargetSageMakerPipelineParameters struct { + _ struct{} `type:"structure"` + + // List of Parameter names and values for SageMaker Model Building Pipeline + // execution. + PipelineParameterList []*SageMakerPipelineParameter `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeTargetSageMakerPipelineParameters) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeTargetSageMakerPipelineParameters) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *PipeTargetSageMakerPipelineParameters) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "PipeTargetSageMakerPipelineParameters"} + if s.PipelineParameterList != nil { + for i, v := range s.PipelineParameterList { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "PipelineParameterList", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetPipelineParameterList sets the PipelineParameterList field's value. +func (s *PipeTargetSageMakerPipelineParameters) SetPipelineParameterList(v []*SageMakerPipelineParameter) *PipeTargetSageMakerPipelineParameters { + s.PipelineParameterList = v + return s +} + +// The parameters for using a Amazon SQS stream as a source. +type PipeTargetSqsQueueParameters struct { + _ struct{} `type:"structure"` + + // This parameter applies only to FIFO (first-in-first-out) queues. + // + // The token used for deduplication of sent messages. + // + // MessageDeduplicationId is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by PipeTargetSqsQueueParameters's + // String and GoString methods. + MessageDeduplicationId *string `type:"string" sensitive:"true"` + + // The FIFO message group ID to use as the target. + // + // MessageGroupId is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by PipeTargetSqsQueueParameters's + // String and GoString methods. + MessageGroupId *string `type:"string" sensitive:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeTargetSqsQueueParameters) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeTargetSqsQueueParameters) GoString() string { + return s.String() +} + +// SetMessageDeduplicationId sets the MessageDeduplicationId field's value. +func (s *PipeTargetSqsQueueParameters) SetMessageDeduplicationId(v string) *PipeTargetSqsQueueParameters { + s.MessageDeduplicationId = &v + return s +} + +// SetMessageGroupId sets the MessageGroupId field's value. +func (s *PipeTargetSqsQueueParameters) SetMessageGroupId(v string) *PipeTargetSqsQueueParameters { + s.MessageGroupId = &v + return s +} + +// The parameters for using a Step Functions state machine as a target. +type PipeTargetStateMachineParameters struct { + _ struct{} `type:"structure"` + + // Specify whether to wait for the state machine to finish or not. + InvocationType *string `type:"string" enum:"PipeTargetInvocationType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeTargetStateMachineParameters) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PipeTargetStateMachineParameters) GoString() string { + return s.String() +} + +// SetInvocationType sets the InvocationType field's value. +func (s *PipeTargetStateMachineParameters) SetInvocationType(v string) *PipeTargetStateMachineParameters { + s.InvocationType = &v + return s +} + +// An object representing a constraint on task placement. To learn more, see +// Task Placement Constraints (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) +// in the Amazon Elastic Container Service Developer Guide. +type PlacementConstraint struct { + _ struct{} `type:"structure"` + + // A cluster query language expression to apply to the constraint. You cannot + // specify an expression if the constraint type is distinctInstance. To learn + // more, see Cluster Query Language (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) + // in the Amazon Elastic Container Service Developer Guide. + // + // Expression is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by PlacementConstraint's + // String and GoString methods. + Expression *string `locationName:"expression" type:"string" sensitive:"true"` + + // The type of constraint. Use distinctInstance to ensure that each task in + // a particular group is running on a different container instance. Use memberOf + // to restrict the selection to a group of valid candidates. + Type *string `locationName:"type" type:"string" enum:"PlacementConstraintType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PlacementConstraint) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PlacementConstraint) GoString() string { + return s.String() +} + +// SetExpression sets the Expression field's value. +func (s *PlacementConstraint) SetExpression(v string) *PlacementConstraint { + s.Expression = &v + return s +} + +// SetType sets the Type field's value. +func (s *PlacementConstraint) SetType(v string) *PlacementConstraint { + s.Type = &v + return s +} + +// The task placement strategy for a task or service. To learn more, see Task +// Placement Strategies (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html) +// in the Amazon Elastic Container Service Service Developer Guide. +type PlacementStrategy struct { + _ struct{} `type:"structure"` + + // The field to apply the placement strategy against. For the spread placement + // strategy, valid values are instanceId (or host, which has the same effect), + // or any platform or custom attribute that is applied to a container instance, + // such as attribute:ecs.availability-zone. For the binpack placement strategy, + // valid values are cpu and memory. For the random placement strategy, this + // field is not used. + // + // Field is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by PlacementStrategy's + // String and GoString methods. + Field *string `locationName:"field" type:"string" sensitive:"true"` + + // The type of placement strategy. The random placement strategy randomly places + // tasks on available candidates. The spread placement strategy spreads placement + // across available candidates evenly based on the field parameter. The binpack + // strategy places tasks on available candidates that have the least available + // amount of the resource that is specified with the field parameter. For example, + // if you binpack on memory, a task is placed on the instance with the least + // amount of remaining memory (but still enough to run the task). + Type *string `locationName:"type" type:"string" enum:"PlacementStrategyType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PlacementStrategy) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PlacementStrategy) GoString() string { + return s.String() +} + +// SetField sets the Field field's value. +func (s *PlacementStrategy) SetField(v string) *PlacementStrategy { + s.Field = &v + return s +} + +// SetType sets the Type field's value. +func (s *PlacementStrategy) SetType(v string) *PlacementStrategy { + s.Type = &v + return s +} + +// Name/Value pair of a parameter to start execution of a SageMaker Model Building +// Pipeline. +type SageMakerPipelineParameter struct { + _ struct{} `type:"structure"` + + // Name of parameter to start execution of a SageMaker Model Building Pipeline. + // + // Name is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by SageMakerPipelineParameter's + // String and GoString methods. + // + // Name is a required field + Name *string `min:"1" type:"string" required:"true" sensitive:"true"` + + // Value of parameter to start execution of a SageMaker Model Building Pipeline. + // + // Value is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by SageMakerPipelineParameter's + // String and GoString methods. + // + // Value is a required field + Value *string `type:"string" required:"true" sensitive:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SageMakerPipelineParameter) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SageMakerPipelineParameter) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *SageMakerPipelineParameter) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "SageMakerPipelineParameter"} + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.Value == nil { + invalidParams.Add(request.NewErrParamRequired("Value")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetName sets the Name field's value. +func (s *SageMakerPipelineParameter) SetName(v string) *SageMakerPipelineParameter { + s.Name = &v + return s +} + +// SetValue sets the Value field's value. +func (s *SageMakerPipelineParameter) SetValue(v string) *SageMakerPipelineParameter { + s.Value = &v + return s +} + +// The Secrets Manager secret that stores your stream credentials. +type SelfManagedKafkaAccessConfigurationCredentials struct { + _ struct{} `type:"structure"` + + // The ARN of the Secrets Manager secret. + BasicAuth *string `min:"1" type:"string"` + + // The ARN of the Secrets Manager secret. + ClientCertificateTlsAuth *string `min:"1" type:"string"` + + // The ARN of the Secrets Manager secret. + SaslScram256Auth *string `min:"1" type:"string"` + + // The ARN of the Secrets Manager secret. + SaslScram512Auth *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SelfManagedKafkaAccessConfigurationCredentials) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SelfManagedKafkaAccessConfigurationCredentials) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *SelfManagedKafkaAccessConfigurationCredentials) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "SelfManagedKafkaAccessConfigurationCredentials"} + if s.BasicAuth != nil && len(*s.BasicAuth) < 1 { + invalidParams.Add(request.NewErrParamMinLen("BasicAuth", 1)) + } + if s.ClientCertificateTlsAuth != nil && len(*s.ClientCertificateTlsAuth) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientCertificateTlsAuth", 1)) + } + if s.SaslScram256Auth != nil && len(*s.SaslScram256Auth) < 1 { + invalidParams.Add(request.NewErrParamMinLen("SaslScram256Auth", 1)) + } + if s.SaslScram512Auth != nil && len(*s.SaslScram512Auth) < 1 { + invalidParams.Add(request.NewErrParamMinLen("SaslScram512Auth", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBasicAuth sets the BasicAuth field's value. +func (s *SelfManagedKafkaAccessConfigurationCredentials) SetBasicAuth(v string) *SelfManagedKafkaAccessConfigurationCredentials { + s.BasicAuth = &v + return s +} + +// SetClientCertificateTlsAuth sets the ClientCertificateTlsAuth field's value. +func (s *SelfManagedKafkaAccessConfigurationCredentials) SetClientCertificateTlsAuth(v string) *SelfManagedKafkaAccessConfigurationCredentials { + s.ClientCertificateTlsAuth = &v + return s +} + +// SetSaslScram256Auth sets the SaslScram256Auth field's value. +func (s *SelfManagedKafkaAccessConfigurationCredentials) SetSaslScram256Auth(v string) *SelfManagedKafkaAccessConfigurationCredentials { + s.SaslScram256Auth = &v + return s +} + +// SetSaslScram512Auth sets the SaslScram512Auth field's value. +func (s *SelfManagedKafkaAccessConfigurationCredentials) SetSaslScram512Auth(v string) *SelfManagedKafkaAccessConfigurationCredentials { + s.SaslScram512Auth = &v + return s +} + +// This structure specifies the VPC subnets and security groups for the stream, +// and whether a public IP address is to be used. +type SelfManagedKafkaAccessConfigurationVpc struct { + _ struct{} `type:"structure"` + + // Specifies the security groups associated with the stream. These security + // groups must all be in the same VPC. You can specify as many as five security + // groups. If you do not specify a security group, the default security group + // for the VPC is used. + SecurityGroup []*string `type:"list"` + + // Specifies the subnets associated with the stream. These subnets must all + // be in the same VPC. You can specify as many as 16 subnets. + Subnets []*string `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SelfManagedKafkaAccessConfigurationVpc) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SelfManagedKafkaAccessConfigurationVpc) GoString() string { + return s.String() +} + +// SetSecurityGroup sets the SecurityGroup field's value. +func (s *SelfManagedKafkaAccessConfigurationVpc) SetSecurityGroup(v []*string) *SelfManagedKafkaAccessConfigurationVpc { + s.SecurityGroup = v + return s +} + +// SetSubnets sets the Subnets field's value. +func (s *SelfManagedKafkaAccessConfigurationVpc) SetSubnets(v []*string) *SelfManagedKafkaAccessConfigurationVpc { + s.Subnets = v + return s +} + +// A quota has been exceeded. +type ServiceQuotaExceededException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" type:"string"` + + // The identifier of the quota that caused the exception. + // + // QuotaCode is a required field + QuotaCode *string `locationName:"quotaCode" type:"string" required:"true"` + + // The ID of the resource that caused the exception. + // + // ResourceId is a required field + ResourceId *string `locationName:"resourceId" type:"string" required:"true"` + + // The type of resource that caused the exception. + // + // ResourceType is a required field + ResourceType *string `locationName:"resourceType" type:"string" required:"true"` + + // The identifier of the service that caused the exception. + // + // ServiceCode is a required field + ServiceCode *string `locationName:"serviceCode" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ServiceQuotaExceededException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ServiceQuotaExceededException) GoString() string { + return s.String() +} + +func newErrorServiceQuotaExceededException(v protocol.ResponseMetadata) error { + return &ServiceQuotaExceededException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ServiceQuotaExceededException) Code() string { + return "ServiceQuotaExceededException" +} + +// Message returns the exception's message. +func (s *ServiceQuotaExceededException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ServiceQuotaExceededException) OrigErr() error { + return nil +} + +func (s *ServiceQuotaExceededException) Error() string { + return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ServiceQuotaExceededException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ServiceQuotaExceededException) RequestID() string { + return s.RespMetadata.RequestID +} + +type StartPipeInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The name of the pipe. + // + // Name is a required field + Name *string `location:"uri" locationName:"Name" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartPipeInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartPipeInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *StartPipeInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "StartPipeInput"} + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetName sets the Name field's value. +func (s *StartPipeInput) SetName(v string) *StartPipeInput { + s.Name = &v + return s +} + +type StartPipeOutput struct { + _ struct{} `type:"structure"` + + // The ARN of the pipe. + Arn *string `min:"1" type:"string"` + + // The time the pipe was created. + CreationTime *time.Time `type:"timestamp"` + + // The state the pipe is in. + CurrentState *string `type:"string" enum:"PipeState"` + + // The state the pipe should be in. + DesiredState *string `type:"string" enum:"RequestedPipeState"` + + // When the pipe was last updated, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime) + // (YYYY-MM-DDThh:mm:ss.sTZD). + LastModifiedTime *time.Time `type:"timestamp"` + + // The name of the pipe. + Name *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartPipeOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartPipeOutput) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *StartPipeOutput) SetArn(v string) *StartPipeOutput { + s.Arn = &v + return s +} + +// SetCreationTime sets the CreationTime field's value. +func (s *StartPipeOutput) SetCreationTime(v time.Time) *StartPipeOutput { + s.CreationTime = &v + return s +} + +// SetCurrentState sets the CurrentState field's value. +func (s *StartPipeOutput) SetCurrentState(v string) *StartPipeOutput { + s.CurrentState = &v + return s +} + +// SetDesiredState sets the DesiredState field's value. +func (s *StartPipeOutput) SetDesiredState(v string) *StartPipeOutput { + s.DesiredState = &v + return s +} + +// SetLastModifiedTime sets the LastModifiedTime field's value. +func (s *StartPipeOutput) SetLastModifiedTime(v time.Time) *StartPipeOutput { + s.LastModifiedTime = &v + return s +} + +// SetName sets the Name field's value. +func (s *StartPipeOutput) SetName(v string) *StartPipeOutput { + s.Name = &v + return s +} + +type StopPipeInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The name of the pipe. + // + // Name is a required field + Name *string `location:"uri" locationName:"Name" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StopPipeInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StopPipeInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *StopPipeInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "StopPipeInput"} + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetName sets the Name field's value. +func (s *StopPipeInput) SetName(v string) *StopPipeInput { + s.Name = &v + return s +} + +type StopPipeOutput struct { + _ struct{} `type:"structure"` + + // The ARN of the pipe. + Arn *string `min:"1" type:"string"` + + // The time the pipe was created. + CreationTime *time.Time `type:"timestamp"` + + // The state the pipe is in. + CurrentState *string `type:"string" enum:"PipeState"` + + // The state the pipe should be in. + DesiredState *string `type:"string" enum:"RequestedPipeState"` + + // When the pipe was last updated, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime) + // (YYYY-MM-DDThh:mm:ss.sTZD). + LastModifiedTime *time.Time `type:"timestamp"` + + // The name of the pipe. + Name *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StopPipeOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StopPipeOutput) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *StopPipeOutput) SetArn(v string) *StopPipeOutput { + s.Arn = &v + return s +} + +// SetCreationTime sets the CreationTime field's value. +func (s *StopPipeOutput) SetCreationTime(v time.Time) *StopPipeOutput { + s.CreationTime = &v + return s +} + +// SetCurrentState sets the CurrentState field's value. +func (s *StopPipeOutput) SetCurrentState(v string) *StopPipeOutput { + s.CurrentState = &v + return s +} + +// SetDesiredState sets the DesiredState field's value. +func (s *StopPipeOutput) SetDesiredState(v string) *StopPipeOutput { + s.DesiredState = &v + return s +} + +// SetLastModifiedTime sets the LastModifiedTime field's value. +func (s *StopPipeOutput) SetLastModifiedTime(v time.Time) *StopPipeOutput { + s.LastModifiedTime = &v + return s +} + +// SetName sets the Name field's value. +func (s *StopPipeOutput) SetName(v string) *StopPipeOutput { + s.Name = &v + return s +} + +// A key-value pair associated with an Amazon Web Services resource. In EventBridge, +// rules and event buses support tagging. +type Tag struct { + _ struct{} `type:"structure"` + + // A string you can use to assign a value. The combination of tag keys and values + // can help you organize and categorize your resources. + // + // Key is a required field + Key *string `min:"1" type:"string" required:"true"` + + // The value for the specified tag key. + // + // Value is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by Tag's + // String and GoString methods. + // + // Value is a required field + Value *string `type:"string" required:"true" sensitive:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Tag) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Tag) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *Tag) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "Tag"} + if s.Key == nil { + invalidParams.Add(request.NewErrParamRequired("Key")) + } + if s.Key != nil && len(*s.Key) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Key", 1)) + } + if s.Value == nil { + invalidParams.Add(request.NewErrParamRequired("Value")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetKey sets the Key field's value. +func (s *Tag) SetKey(v string) *Tag { + s.Key = &v + return s +} + +// SetValue sets the Value field's value. +func (s *Tag) SetValue(v string) *Tag { + s.Value = &v + return s +} + +type TagResourceInput struct { + _ struct{} `type:"structure"` + + // The ARN of the pipe. + // + // ResourceArn is a required field + ResourceArn *string `location:"uri" locationName:"resourceArn" min:"1" type:"string" required:"true"` + + // The list of key-value pairs associated with the pipe. + // + // Tags is a required field + Tags map[string]*string `locationName:"tags" min:"1" type:"map" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TagResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TagResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *TagResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "TagResourceInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ResourceArn != nil && len(*s.ResourceArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1)) + } + if s.Tags == nil { + invalidParams.Add(request.NewErrParamRequired("Tags")) + } + if s.Tags != nil && len(s.Tags) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Tags", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput { + s.ResourceArn = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput { + s.Tags = v + return s +} + +type TagResourceOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TagResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TagResourceOutput) GoString() string { + return s.String() +} + +// An action was throttled. +type ThrottlingException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" type:"string"` + + // The identifier of the quota that caused the exception. + QuotaCode *string `locationName:"quotaCode" type:"string"` + + // The number of seconds to wait before retrying the action that caused the + // exception. + RetryAfterSeconds *int64 `location:"header" locationName:"Retry-After" type:"integer"` + + // The identifier of the service that caused the exception. + ServiceCode *string `locationName:"serviceCode" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ThrottlingException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ThrottlingException) GoString() string { + return s.String() +} + +func newErrorThrottlingException(v protocol.ResponseMetadata) error { + return &ThrottlingException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ThrottlingException) Code() string { + return "ThrottlingException" +} + +// Message returns the exception's message. +func (s *ThrottlingException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ThrottlingException) OrigErr() error { + return nil +} + +func (s *ThrottlingException) Error() string { + return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ThrottlingException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ThrottlingException) RequestID() string { + return s.RespMetadata.RequestID +} + +type UntagResourceInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The ARN of the pipe. + // + // ResourceArn is a required field + ResourceArn *string `location:"uri" locationName:"resourceArn" min:"1" type:"string" required:"true"` + + // The list of tag keys to remove from the pipe. + // + // TagKeys is a required field + TagKeys []*string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UntagResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UntagResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UntagResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UntagResourceInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ResourceArn != nil && len(*s.ResourceArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1)) + } + if s.TagKeys == nil { + invalidParams.Add(request.NewErrParamRequired("TagKeys")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput { + s.ResourceArn = &v + return s +} + +// SetTagKeys sets the TagKeys field's value. +func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput { + s.TagKeys = v + return s +} + +type UntagResourceOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UntagResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UntagResourceOutput) GoString() string { + return s.String() +} + +type UpdatePipeInput struct { + _ struct{} `type:"structure"` + + // A description of the pipe. + // + // Description is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by UpdatePipeInput's + // String and GoString methods. + Description *string `type:"string" sensitive:"true"` + + // The state the pipe should be in. + DesiredState *string `type:"string" enum:"RequestedPipeState"` + + // The ARN of the enrichment resource. + Enrichment *string `type:"string"` + + // The parameters required to set up enrichment on your pipe. + EnrichmentParameters *PipeEnrichmentParameters `type:"structure"` + + // The name of the pipe. + // + // Name is a required field + Name *string `location:"uri" locationName:"Name" min:"1" type:"string" required:"true"` + + // The ARN of the role that allows the pipe to send data to the target. + // + // RoleArn is a required field + RoleArn *string `min:"1" type:"string" required:"true"` + + // The parameters required to set up a source for your pipe. + SourceParameters *UpdatePipeSourceParameters `type:"structure"` + + // The ARN of the target resource. + Target *string `min:"1" type:"string"` + + // The parameters required to set up a target for your pipe. + TargetParameters *PipeTargetParameters `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdatePipeInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdatePipeInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdatePipeInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdatePipeInput"} + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.RoleArn == nil { + invalidParams.Add(request.NewErrParamRequired("RoleArn")) + } + if s.RoleArn != nil && len(*s.RoleArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("RoleArn", 1)) + } + if s.Target != nil && len(*s.Target) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Target", 1)) + } + if s.SourceParameters != nil { + if err := s.SourceParameters.Validate(); err != nil { + invalidParams.AddNested("SourceParameters", err.(request.ErrInvalidParams)) + } + } + if s.TargetParameters != nil { + if err := s.TargetParameters.Validate(); err != nil { + invalidParams.AddNested("TargetParameters", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDescription sets the Description field's value. +func (s *UpdatePipeInput) SetDescription(v string) *UpdatePipeInput { + s.Description = &v + return s +} + +// SetDesiredState sets the DesiredState field's value. +func (s *UpdatePipeInput) SetDesiredState(v string) *UpdatePipeInput { + s.DesiredState = &v + return s +} + +// SetEnrichment sets the Enrichment field's value. +func (s *UpdatePipeInput) SetEnrichment(v string) *UpdatePipeInput { + s.Enrichment = &v + return s +} + +// SetEnrichmentParameters sets the EnrichmentParameters field's value. +func (s *UpdatePipeInput) SetEnrichmentParameters(v *PipeEnrichmentParameters) *UpdatePipeInput { + s.EnrichmentParameters = v + return s +} + +// SetName sets the Name field's value. +func (s *UpdatePipeInput) SetName(v string) *UpdatePipeInput { + s.Name = &v + return s +} + +// SetRoleArn sets the RoleArn field's value. +func (s *UpdatePipeInput) SetRoleArn(v string) *UpdatePipeInput { + s.RoleArn = &v + return s +} + +// SetSourceParameters sets the SourceParameters field's value. +func (s *UpdatePipeInput) SetSourceParameters(v *UpdatePipeSourceParameters) *UpdatePipeInput { + s.SourceParameters = v + return s +} + +// SetTarget sets the Target field's value. +func (s *UpdatePipeInput) SetTarget(v string) *UpdatePipeInput { + s.Target = &v + return s +} + +// SetTargetParameters sets the TargetParameters field's value. +func (s *UpdatePipeInput) SetTargetParameters(v *PipeTargetParameters) *UpdatePipeInput { + s.TargetParameters = v + return s +} + +type UpdatePipeOutput struct { + _ struct{} `type:"structure"` + + // The ARN of the pipe. + Arn *string `min:"1" type:"string"` + + // The time the pipe was created. + CreationTime *time.Time `type:"timestamp"` + + // The state the pipe is in. + CurrentState *string `type:"string" enum:"PipeState"` + + // The state the pipe should be in. + DesiredState *string `type:"string" enum:"RequestedPipeState"` + + // When the pipe was last updated, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime) + // (YYYY-MM-DDThh:mm:ss.sTZD). + LastModifiedTime *time.Time `type:"timestamp"` + + // The name of the pipe. + Name *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdatePipeOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdatePipeOutput) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *UpdatePipeOutput) SetArn(v string) *UpdatePipeOutput { + s.Arn = &v + return s +} + +// SetCreationTime sets the CreationTime field's value. +func (s *UpdatePipeOutput) SetCreationTime(v time.Time) *UpdatePipeOutput { + s.CreationTime = &v + return s +} + +// SetCurrentState sets the CurrentState field's value. +func (s *UpdatePipeOutput) SetCurrentState(v string) *UpdatePipeOutput { + s.CurrentState = &v + return s +} + +// SetDesiredState sets the DesiredState field's value. +func (s *UpdatePipeOutput) SetDesiredState(v string) *UpdatePipeOutput { + s.DesiredState = &v + return s +} + +// SetLastModifiedTime sets the LastModifiedTime field's value. +func (s *UpdatePipeOutput) SetLastModifiedTime(v time.Time) *UpdatePipeOutput { + s.LastModifiedTime = &v + return s +} + +// SetName sets the Name field's value. +func (s *UpdatePipeOutput) SetName(v string) *UpdatePipeOutput { + s.Name = &v + return s +} + +// The parameters for using an Active MQ broker as a source. +type UpdatePipeSourceActiveMQBrokerParameters struct { + _ struct{} `type:"structure"` + + // The maximum number of records to include in each batch. + BatchSize *int64 `min:"1" type:"integer"` + + // The credentials needed to access the resource. + // + // Credentials is a required field + Credentials *MQBrokerAccessCredentials `type:"structure" required:"true"` + + // The maximum length of a time to wait for events. + MaximumBatchingWindowInSeconds *int64 `type:"integer"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdatePipeSourceActiveMQBrokerParameters) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdatePipeSourceActiveMQBrokerParameters) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdatePipeSourceActiveMQBrokerParameters) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdatePipeSourceActiveMQBrokerParameters"} + if s.BatchSize != nil && *s.BatchSize < 1 { + invalidParams.Add(request.NewErrParamMinValue("BatchSize", 1)) + } + if s.Credentials == nil { + invalidParams.Add(request.NewErrParamRequired("Credentials")) + } + if s.Credentials != nil { + if err := s.Credentials.Validate(); err != nil { + invalidParams.AddNested("Credentials", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBatchSize sets the BatchSize field's value. +func (s *UpdatePipeSourceActiveMQBrokerParameters) SetBatchSize(v int64) *UpdatePipeSourceActiveMQBrokerParameters { + s.BatchSize = &v + return s +} + +// SetCredentials sets the Credentials field's value. +func (s *UpdatePipeSourceActiveMQBrokerParameters) SetCredentials(v *MQBrokerAccessCredentials) *UpdatePipeSourceActiveMQBrokerParameters { + s.Credentials = v + return s +} + +// SetMaximumBatchingWindowInSeconds sets the MaximumBatchingWindowInSeconds field's value. +func (s *UpdatePipeSourceActiveMQBrokerParameters) SetMaximumBatchingWindowInSeconds(v int64) *UpdatePipeSourceActiveMQBrokerParameters { + s.MaximumBatchingWindowInSeconds = &v + return s +} + +// The parameters for using a DynamoDB stream as a source. +type UpdatePipeSourceDynamoDBStreamParameters struct { + _ struct{} `type:"structure"` + + // The maximum number of records to include in each batch. + BatchSize *int64 `min:"1" type:"integer"` + + // Define the target queue to send dead-letter queue events to. + DeadLetterConfig *DeadLetterConfig `type:"structure"` + + // The maximum length of a time to wait for events. + MaximumBatchingWindowInSeconds *int64 `type:"integer"` + + // (Streams only) Discard records older than the specified age. The default + // value is -1, which sets the maximum age to infinite. When the value is set + // to infinite, EventBridge never discards old records. + MaximumRecordAgeInSeconds *int64 `type:"integer"` + + // (Streams only) Discard records after the specified number of retries. The + // default value is -1, which sets the maximum number of retries to infinite. + // When MaximumRetryAttempts is infinite, EventBridge retries failed records + // until the record expires in the event source. + MaximumRetryAttempts *int64 `type:"integer"` + + // (Streams only) Define how to handle item process failures. AUTOMATIC_BISECT + // halves each batch and retry each half until all the records are processed + // or there is one failed message left in the batch. + OnPartialBatchItemFailure *string `type:"string" enum:"OnPartialBatchItemFailureStreams"` + + // (Streams only) The number of batches to process concurrently from each shard. + // The default value is 1. + ParallelizationFactor *int64 `min:"1" type:"integer"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdatePipeSourceDynamoDBStreamParameters) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdatePipeSourceDynamoDBStreamParameters) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdatePipeSourceDynamoDBStreamParameters) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdatePipeSourceDynamoDBStreamParameters"} + if s.BatchSize != nil && *s.BatchSize < 1 { + invalidParams.Add(request.NewErrParamMinValue("BatchSize", 1)) + } + if s.MaximumRecordAgeInSeconds != nil && *s.MaximumRecordAgeInSeconds < -1 { + invalidParams.Add(request.NewErrParamMinValue("MaximumRecordAgeInSeconds", -1)) + } + if s.MaximumRetryAttempts != nil && *s.MaximumRetryAttempts < -1 { + invalidParams.Add(request.NewErrParamMinValue("MaximumRetryAttempts", -1)) + } + if s.ParallelizationFactor != nil && *s.ParallelizationFactor < 1 { + invalidParams.Add(request.NewErrParamMinValue("ParallelizationFactor", 1)) + } + if s.DeadLetterConfig != nil { + if err := s.DeadLetterConfig.Validate(); err != nil { + invalidParams.AddNested("DeadLetterConfig", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBatchSize sets the BatchSize field's value. +func (s *UpdatePipeSourceDynamoDBStreamParameters) SetBatchSize(v int64) *UpdatePipeSourceDynamoDBStreamParameters { + s.BatchSize = &v + return s +} + +// SetDeadLetterConfig sets the DeadLetterConfig field's value. +func (s *UpdatePipeSourceDynamoDBStreamParameters) SetDeadLetterConfig(v *DeadLetterConfig) *UpdatePipeSourceDynamoDBStreamParameters { + s.DeadLetterConfig = v + return s +} + +// SetMaximumBatchingWindowInSeconds sets the MaximumBatchingWindowInSeconds field's value. +func (s *UpdatePipeSourceDynamoDBStreamParameters) SetMaximumBatchingWindowInSeconds(v int64) *UpdatePipeSourceDynamoDBStreamParameters { + s.MaximumBatchingWindowInSeconds = &v + return s +} + +// SetMaximumRecordAgeInSeconds sets the MaximumRecordAgeInSeconds field's value. +func (s *UpdatePipeSourceDynamoDBStreamParameters) SetMaximumRecordAgeInSeconds(v int64) *UpdatePipeSourceDynamoDBStreamParameters { + s.MaximumRecordAgeInSeconds = &v + return s +} + +// SetMaximumRetryAttempts sets the MaximumRetryAttempts field's value. +func (s *UpdatePipeSourceDynamoDBStreamParameters) SetMaximumRetryAttempts(v int64) *UpdatePipeSourceDynamoDBStreamParameters { + s.MaximumRetryAttempts = &v + return s +} + +// SetOnPartialBatchItemFailure sets the OnPartialBatchItemFailure field's value. +func (s *UpdatePipeSourceDynamoDBStreamParameters) SetOnPartialBatchItemFailure(v string) *UpdatePipeSourceDynamoDBStreamParameters { + s.OnPartialBatchItemFailure = &v + return s +} + +// SetParallelizationFactor sets the ParallelizationFactor field's value. +func (s *UpdatePipeSourceDynamoDBStreamParameters) SetParallelizationFactor(v int64) *UpdatePipeSourceDynamoDBStreamParameters { + s.ParallelizationFactor = &v + return s +} + +// The parameters for using a Kinesis stream as a source. +type UpdatePipeSourceKinesisStreamParameters struct { + _ struct{} `type:"structure"` + + // The maximum number of records to include in each batch. + BatchSize *int64 `min:"1" type:"integer"` + + // Define the target queue to send dead-letter queue events to. + DeadLetterConfig *DeadLetterConfig `type:"structure"` + + // The maximum length of a time to wait for events. + MaximumBatchingWindowInSeconds *int64 `type:"integer"` + + // (Streams only) Discard records older than the specified age. The default + // value is -1, which sets the maximum age to infinite. When the value is set + // to infinite, EventBridge never discards old records. + MaximumRecordAgeInSeconds *int64 `type:"integer"` + + // (Streams only) Discard records after the specified number of retries. The + // default value is -1, which sets the maximum number of retries to infinite. + // When MaximumRetryAttempts is infinite, EventBridge retries failed records + // until the record expires in the event source. + MaximumRetryAttempts *int64 `type:"integer"` + + // (Streams only) Define how to handle item process failures. AUTOMATIC_BISECT + // halves each batch and retry each half until all the records are processed + // or there is one failed message left in the batch. + OnPartialBatchItemFailure *string `type:"string" enum:"OnPartialBatchItemFailureStreams"` + + // (Streams only) The number of batches to process concurrently from each shard. + // The default value is 1. + ParallelizationFactor *int64 `min:"1" type:"integer"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdatePipeSourceKinesisStreamParameters) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdatePipeSourceKinesisStreamParameters) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdatePipeSourceKinesisStreamParameters) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdatePipeSourceKinesisStreamParameters"} + if s.BatchSize != nil && *s.BatchSize < 1 { + invalidParams.Add(request.NewErrParamMinValue("BatchSize", 1)) + } + if s.MaximumRecordAgeInSeconds != nil && *s.MaximumRecordAgeInSeconds < -1 { + invalidParams.Add(request.NewErrParamMinValue("MaximumRecordAgeInSeconds", -1)) + } + if s.MaximumRetryAttempts != nil && *s.MaximumRetryAttempts < -1 { + invalidParams.Add(request.NewErrParamMinValue("MaximumRetryAttempts", -1)) + } + if s.ParallelizationFactor != nil && *s.ParallelizationFactor < 1 { + invalidParams.Add(request.NewErrParamMinValue("ParallelizationFactor", 1)) + } + if s.DeadLetterConfig != nil { + if err := s.DeadLetterConfig.Validate(); err != nil { + invalidParams.AddNested("DeadLetterConfig", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBatchSize sets the BatchSize field's value. +func (s *UpdatePipeSourceKinesisStreamParameters) SetBatchSize(v int64) *UpdatePipeSourceKinesisStreamParameters { + s.BatchSize = &v + return s +} + +// SetDeadLetterConfig sets the DeadLetterConfig field's value. +func (s *UpdatePipeSourceKinesisStreamParameters) SetDeadLetterConfig(v *DeadLetterConfig) *UpdatePipeSourceKinesisStreamParameters { + s.DeadLetterConfig = v + return s +} + +// SetMaximumBatchingWindowInSeconds sets the MaximumBatchingWindowInSeconds field's value. +func (s *UpdatePipeSourceKinesisStreamParameters) SetMaximumBatchingWindowInSeconds(v int64) *UpdatePipeSourceKinesisStreamParameters { + s.MaximumBatchingWindowInSeconds = &v + return s +} + +// SetMaximumRecordAgeInSeconds sets the MaximumRecordAgeInSeconds field's value. +func (s *UpdatePipeSourceKinesisStreamParameters) SetMaximumRecordAgeInSeconds(v int64) *UpdatePipeSourceKinesisStreamParameters { + s.MaximumRecordAgeInSeconds = &v + return s +} + +// SetMaximumRetryAttempts sets the MaximumRetryAttempts field's value. +func (s *UpdatePipeSourceKinesisStreamParameters) SetMaximumRetryAttempts(v int64) *UpdatePipeSourceKinesisStreamParameters { + s.MaximumRetryAttempts = &v + return s +} + +// SetOnPartialBatchItemFailure sets the OnPartialBatchItemFailure field's value. +func (s *UpdatePipeSourceKinesisStreamParameters) SetOnPartialBatchItemFailure(v string) *UpdatePipeSourceKinesisStreamParameters { + s.OnPartialBatchItemFailure = &v + return s +} + +// SetParallelizationFactor sets the ParallelizationFactor field's value. +func (s *UpdatePipeSourceKinesisStreamParameters) SetParallelizationFactor(v int64) *UpdatePipeSourceKinesisStreamParameters { + s.ParallelizationFactor = &v + return s +} + +// The parameters for using an MSK stream as a source. +type UpdatePipeSourceManagedStreamingKafkaParameters struct { + _ struct{} `type:"structure"` + + // The maximum number of records to include in each batch. + BatchSize *int64 `min:"1" type:"integer"` + + // The credentials needed to access the resource. + Credentials *MSKAccessCredentials `type:"structure"` + + // The maximum length of a time to wait for events. + MaximumBatchingWindowInSeconds *int64 `type:"integer"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdatePipeSourceManagedStreamingKafkaParameters) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdatePipeSourceManagedStreamingKafkaParameters) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdatePipeSourceManagedStreamingKafkaParameters) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdatePipeSourceManagedStreamingKafkaParameters"} + if s.BatchSize != nil && *s.BatchSize < 1 { + invalidParams.Add(request.NewErrParamMinValue("BatchSize", 1)) + } + if s.Credentials != nil { + if err := s.Credentials.Validate(); err != nil { + invalidParams.AddNested("Credentials", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBatchSize sets the BatchSize field's value. +func (s *UpdatePipeSourceManagedStreamingKafkaParameters) SetBatchSize(v int64) *UpdatePipeSourceManagedStreamingKafkaParameters { + s.BatchSize = &v + return s +} + +// SetCredentials sets the Credentials field's value. +func (s *UpdatePipeSourceManagedStreamingKafkaParameters) SetCredentials(v *MSKAccessCredentials) *UpdatePipeSourceManagedStreamingKafkaParameters { + s.Credentials = v + return s +} + +// SetMaximumBatchingWindowInSeconds sets the MaximumBatchingWindowInSeconds field's value. +func (s *UpdatePipeSourceManagedStreamingKafkaParameters) SetMaximumBatchingWindowInSeconds(v int64) *UpdatePipeSourceManagedStreamingKafkaParameters { + s.MaximumBatchingWindowInSeconds = &v + return s +} + +// The parameters required to set up a source for your pipe. +type UpdatePipeSourceParameters struct { + _ struct{} `type:"structure"` + + // The parameters for using an Active MQ broker as a source. + ActiveMQBrokerParameters *UpdatePipeSourceActiveMQBrokerParameters `type:"structure"` + + // The parameters for using a DynamoDB stream as a source. + DynamoDBStreamParameters *UpdatePipeSourceDynamoDBStreamParameters `type:"structure"` + + // The collection of event patterns used to filter events. For more information, + // see Events and Event Patterns (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) + // in the Amazon EventBridge User Guide. + FilterCriteria *FilterCriteria `type:"structure"` + + // The parameters for using a Kinesis stream as a source. + KinesisStreamParameters *UpdatePipeSourceKinesisStreamParameters `type:"structure"` + + // The parameters for using an MSK stream as a source. + ManagedStreamingKafkaParameters *UpdatePipeSourceManagedStreamingKafkaParameters `type:"structure"` + + // The parameters for using a Rabbit MQ broker as a source. + RabbitMQBrokerParameters *UpdatePipeSourceRabbitMQBrokerParameters `type:"structure"` + + // The parameters for using a self-managed Apache Kafka stream as a source. + SelfManagedKafkaParameters *UpdatePipeSourceSelfManagedKafkaParameters `type:"structure"` + + // The parameters for using a Amazon SQS stream as a source. + SqsQueueParameters *UpdatePipeSourceSqsQueueParameters `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdatePipeSourceParameters) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdatePipeSourceParameters) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdatePipeSourceParameters) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdatePipeSourceParameters"} + if s.ActiveMQBrokerParameters != nil { + if err := s.ActiveMQBrokerParameters.Validate(); err != nil { + invalidParams.AddNested("ActiveMQBrokerParameters", err.(request.ErrInvalidParams)) + } + } + if s.DynamoDBStreamParameters != nil { + if err := s.DynamoDBStreamParameters.Validate(); err != nil { + invalidParams.AddNested("DynamoDBStreamParameters", err.(request.ErrInvalidParams)) + } + } + if s.KinesisStreamParameters != nil { + if err := s.KinesisStreamParameters.Validate(); err != nil { + invalidParams.AddNested("KinesisStreamParameters", err.(request.ErrInvalidParams)) + } + } + if s.ManagedStreamingKafkaParameters != nil { + if err := s.ManagedStreamingKafkaParameters.Validate(); err != nil { + invalidParams.AddNested("ManagedStreamingKafkaParameters", err.(request.ErrInvalidParams)) + } + } + if s.RabbitMQBrokerParameters != nil { + if err := s.RabbitMQBrokerParameters.Validate(); err != nil { + invalidParams.AddNested("RabbitMQBrokerParameters", err.(request.ErrInvalidParams)) + } + } + if s.SelfManagedKafkaParameters != nil { + if err := s.SelfManagedKafkaParameters.Validate(); err != nil { + invalidParams.AddNested("SelfManagedKafkaParameters", err.(request.ErrInvalidParams)) + } + } + if s.SqsQueueParameters != nil { + if err := s.SqsQueueParameters.Validate(); err != nil { + invalidParams.AddNested("SqsQueueParameters", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetActiveMQBrokerParameters sets the ActiveMQBrokerParameters field's value. +func (s *UpdatePipeSourceParameters) SetActiveMQBrokerParameters(v *UpdatePipeSourceActiveMQBrokerParameters) *UpdatePipeSourceParameters { + s.ActiveMQBrokerParameters = v + return s +} + +// SetDynamoDBStreamParameters sets the DynamoDBStreamParameters field's value. +func (s *UpdatePipeSourceParameters) SetDynamoDBStreamParameters(v *UpdatePipeSourceDynamoDBStreamParameters) *UpdatePipeSourceParameters { + s.DynamoDBStreamParameters = v + return s +} + +// SetFilterCriteria sets the FilterCriteria field's value. +func (s *UpdatePipeSourceParameters) SetFilterCriteria(v *FilterCriteria) *UpdatePipeSourceParameters { + s.FilterCriteria = v + return s +} + +// SetKinesisStreamParameters sets the KinesisStreamParameters field's value. +func (s *UpdatePipeSourceParameters) SetKinesisStreamParameters(v *UpdatePipeSourceKinesisStreamParameters) *UpdatePipeSourceParameters { + s.KinesisStreamParameters = v + return s +} + +// SetManagedStreamingKafkaParameters sets the ManagedStreamingKafkaParameters field's value. +func (s *UpdatePipeSourceParameters) SetManagedStreamingKafkaParameters(v *UpdatePipeSourceManagedStreamingKafkaParameters) *UpdatePipeSourceParameters { + s.ManagedStreamingKafkaParameters = v + return s +} + +// SetRabbitMQBrokerParameters sets the RabbitMQBrokerParameters field's value. +func (s *UpdatePipeSourceParameters) SetRabbitMQBrokerParameters(v *UpdatePipeSourceRabbitMQBrokerParameters) *UpdatePipeSourceParameters { + s.RabbitMQBrokerParameters = v + return s +} + +// SetSelfManagedKafkaParameters sets the SelfManagedKafkaParameters field's value. +func (s *UpdatePipeSourceParameters) SetSelfManagedKafkaParameters(v *UpdatePipeSourceSelfManagedKafkaParameters) *UpdatePipeSourceParameters { + s.SelfManagedKafkaParameters = v + return s +} + +// SetSqsQueueParameters sets the SqsQueueParameters field's value. +func (s *UpdatePipeSourceParameters) SetSqsQueueParameters(v *UpdatePipeSourceSqsQueueParameters) *UpdatePipeSourceParameters { + s.SqsQueueParameters = v + return s +} + +// The parameters for using a Rabbit MQ broker as a source. +type UpdatePipeSourceRabbitMQBrokerParameters struct { + _ struct{} `type:"structure"` + + // The maximum number of records to include in each batch. + BatchSize *int64 `min:"1" type:"integer"` + + // The credentials needed to access the resource. + // + // Credentials is a required field + Credentials *MQBrokerAccessCredentials `type:"structure" required:"true"` + + // The maximum length of a time to wait for events. + MaximumBatchingWindowInSeconds *int64 `type:"integer"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdatePipeSourceRabbitMQBrokerParameters) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdatePipeSourceRabbitMQBrokerParameters) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdatePipeSourceRabbitMQBrokerParameters) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdatePipeSourceRabbitMQBrokerParameters"} + if s.BatchSize != nil && *s.BatchSize < 1 { + invalidParams.Add(request.NewErrParamMinValue("BatchSize", 1)) + } + if s.Credentials == nil { + invalidParams.Add(request.NewErrParamRequired("Credentials")) + } + if s.Credentials != nil { + if err := s.Credentials.Validate(); err != nil { + invalidParams.AddNested("Credentials", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBatchSize sets the BatchSize field's value. +func (s *UpdatePipeSourceRabbitMQBrokerParameters) SetBatchSize(v int64) *UpdatePipeSourceRabbitMQBrokerParameters { + s.BatchSize = &v + return s +} + +// SetCredentials sets the Credentials field's value. +func (s *UpdatePipeSourceRabbitMQBrokerParameters) SetCredentials(v *MQBrokerAccessCredentials) *UpdatePipeSourceRabbitMQBrokerParameters { + s.Credentials = v + return s +} + +// SetMaximumBatchingWindowInSeconds sets the MaximumBatchingWindowInSeconds field's value. +func (s *UpdatePipeSourceRabbitMQBrokerParameters) SetMaximumBatchingWindowInSeconds(v int64) *UpdatePipeSourceRabbitMQBrokerParameters { + s.MaximumBatchingWindowInSeconds = &v + return s +} + +// The parameters for using a self-managed Apache Kafka stream as a source. +type UpdatePipeSourceSelfManagedKafkaParameters struct { + _ struct{} `type:"structure"` + + // The maximum number of records to include in each batch. + BatchSize *int64 `min:"1" type:"integer"` + + // The credentials needed to access the resource. + Credentials *SelfManagedKafkaAccessConfigurationCredentials `type:"structure"` + + // The maximum length of a time to wait for events. + MaximumBatchingWindowInSeconds *int64 `type:"integer"` + + // The ARN of the Secrets Manager secret used for certification. + ServerRootCaCertificate *string `min:"1" type:"string"` + + // This structure specifies the VPC subnets and security groups for the stream, + // and whether a public IP address is to be used. + Vpc *SelfManagedKafkaAccessConfigurationVpc `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdatePipeSourceSelfManagedKafkaParameters) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdatePipeSourceSelfManagedKafkaParameters) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdatePipeSourceSelfManagedKafkaParameters) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdatePipeSourceSelfManagedKafkaParameters"} + if s.BatchSize != nil && *s.BatchSize < 1 { + invalidParams.Add(request.NewErrParamMinValue("BatchSize", 1)) + } + if s.ServerRootCaCertificate != nil && len(*s.ServerRootCaCertificate) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ServerRootCaCertificate", 1)) + } + if s.Credentials != nil { + if err := s.Credentials.Validate(); err != nil { + invalidParams.AddNested("Credentials", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBatchSize sets the BatchSize field's value. +func (s *UpdatePipeSourceSelfManagedKafkaParameters) SetBatchSize(v int64) *UpdatePipeSourceSelfManagedKafkaParameters { + s.BatchSize = &v + return s +} + +// SetCredentials sets the Credentials field's value. +func (s *UpdatePipeSourceSelfManagedKafkaParameters) SetCredentials(v *SelfManagedKafkaAccessConfigurationCredentials) *UpdatePipeSourceSelfManagedKafkaParameters { + s.Credentials = v + return s +} + +// SetMaximumBatchingWindowInSeconds sets the MaximumBatchingWindowInSeconds field's value. +func (s *UpdatePipeSourceSelfManagedKafkaParameters) SetMaximumBatchingWindowInSeconds(v int64) *UpdatePipeSourceSelfManagedKafkaParameters { + s.MaximumBatchingWindowInSeconds = &v + return s +} + +// SetServerRootCaCertificate sets the ServerRootCaCertificate field's value. +func (s *UpdatePipeSourceSelfManagedKafkaParameters) SetServerRootCaCertificate(v string) *UpdatePipeSourceSelfManagedKafkaParameters { + s.ServerRootCaCertificate = &v + return s +} + +// SetVpc sets the Vpc field's value. +func (s *UpdatePipeSourceSelfManagedKafkaParameters) SetVpc(v *SelfManagedKafkaAccessConfigurationVpc) *UpdatePipeSourceSelfManagedKafkaParameters { + s.Vpc = v + return s +} + +// The parameters for using a Amazon SQS stream as a source. +type UpdatePipeSourceSqsQueueParameters struct { + _ struct{} `type:"structure"` + + // The maximum number of records to include in each batch. + BatchSize *int64 `min:"1" type:"integer"` + + // The maximum length of a time to wait for events. + MaximumBatchingWindowInSeconds *int64 `type:"integer"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdatePipeSourceSqsQueueParameters) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdatePipeSourceSqsQueueParameters) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdatePipeSourceSqsQueueParameters) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdatePipeSourceSqsQueueParameters"} + if s.BatchSize != nil && *s.BatchSize < 1 { + invalidParams.Add(request.NewErrParamMinValue("BatchSize", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBatchSize sets the BatchSize field's value. +func (s *UpdatePipeSourceSqsQueueParameters) SetBatchSize(v int64) *UpdatePipeSourceSqsQueueParameters { + s.BatchSize = &v + return s +} + +// SetMaximumBatchingWindowInSeconds sets the MaximumBatchingWindowInSeconds field's value. +func (s *UpdatePipeSourceSqsQueueParameters) SetMaximumBatchingWindowInSeconds(v int64) *UpdatePipeSourceSqsQueueParameters { + s.MaximumBatchingWindowInSeconds = &v + return s +} + +// Indicates that an error has occurred while performing a validate operation. +type ValidationException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + // The list of fields for which validation failed and the corresponding failure + // messages. + FieldList []*ValidationExceptionField `locationName:"fieldList" type:"list"` + + Message_ *string `locationName:"message" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ValidationException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ValidationException) GoString() string { + return s.String() +} + +func newErrorValidationException(v protocol.ResponseMetadata) error { + return &ValidationException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ValidationException) Code() string { + return "ValidationException" +} + +// Message returns the exception's message. +func (s *ValidationException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ValidationException) OrigErr() error { + return nil +} + +func (s *ValidationException) Error() string { + return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ValidationException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ValidationException) RequestID() string { + return s.RespMetadata.RequestID +} + +// Indicates that an error has occurred while performing a validate operation. +type ValidationExceptionField struct { + _ struct{} `type:"structure"` + + // The message of the exception. + // + // Message is a required field + Message *string `locationName:"message" type:"string" required:"true"` + + // The name of the exception. + // + // Name is a required field + Name *string `locationName:"name" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ValidationExceptionField) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ValidationExceptionField) GoString() string { + return s.String() +} + +// SetMessage sets the Message field's value. +func (s *ValidationExceptionField) SetMessage(v string) *ValidationExceptionField { + s.Message = &v + return s +} + +// SetName sets the Name field's value. +func (s *ValidationExceptionField) SetName(v string) *ValidationExceptionField { + s.Name = &v + return s +} + +const ( + // AssignPublicIpEnabled is a AssignPublicIp enum value + AssignPublicIpEnabled = "ENABLED" + + // AssignPublicIpDisabled is a AssignPublicIp enum value + AssignPublicIpDisabled = "DISABLED" +) + +// AssignPublicIp_Values returns all elements of the AssignPublicIp enum +func AssignPublicIp_Values() []string { + return []string{ + AssignPublicIpEnabled, + AssignPublicIpDisabled, + } +} + +const ( + // BatchJobDependencyTypeNToN is a BatchJobDependencyType enum value + BatchJobDependencyTypeNToN = "N_TO_N" + + // BatchJobDependencyTypeSequential is a BatchJobDependencyType enum value + BatchJobDependencyTypeSequential = "SEQUENTIAL" +) + +// BatchJobDependencyType_Values returns all elements of the BatchJobDependencyType enum +func BatchJobDependencyType_Values() []string { + return []string{ + BatchJobDependencyTypeNToN, + BatchJobDependencyTypeSequential, + } +} + +const ( + // BatchResourceRequirementTypeGpu is a BatchResourceRequirementType enum value + BatchResourceRequirementTypeGpu = "GPU" + + // BatchResourceRequirementTypeMemory is a BatchResourceRequirementType enum value + BatchResourceRequirementTypeMemory = "MEMORY" + + // BatchResourceRequirementTypeVcpu is a BatchResourceRequirementType enum value + BatchResourceRequirementTypeVcpu = "VCPU" +) + +// BatchResourceRequirementType_Values returns all elements of the BatchResourceRequirementType enum +func BatchResourceRequirementType_Values() []string { + return []string{ + BatchResourceRequirementTypeGpu, + BatchResourceRequirementTypeMemory, + BatchResourceRequirementTypeVcpu, + } +} + +const ( + // DynamoDBStreamStartPositionTrimHorizon is a DynamoDBStreamStartPosition enum value + DynamoDBStreamStartPositionTrimHorizon = "TRIM_HORIZON" + + // DynamoDBStreamStartPositionLatest is a DynamoDBStreamStartPosition enum value + DynamoDBStreamStartPositionLatest = "LATEST" +) + +// DynamoDBStreamStartPosition_Values returns all elements of the DynamoDBStreamStartPosition enum +func DynamoDBStreamStartPosition_Values() []string { + return []string{ + DynamoDBStreamStartPositionTrimHorizon, + DynamoDBStreamStartPositionLatest, + } +} + +const ( + // EcsEnvironmentFileTypeS3 is a EcsEnvironmentFileType enum value + EcsEnvironmentFileTypeS3 = "s3" +) + +// EcsEnvironmentFileType_Values returns all elements of the EcsEnvironmentFileType enum +func EcsEnvironmentFileType_Values() []string { + return []string{ + EcsEnvironmentFileTypeS3, + } +} + +const ( + // EcsResourceRequirementTypeGpu is a EcsResourceRequirementType enum value + EcsResourceRequirementTypeGpu = "GPU" + + // EcsResourceRequirementTypeInferenceAccelerator is a EcsResourceRequirementType enum value + EcsResourceRequirementTypeInferenceAccelerator = "InferenceAccelerator" +) + +// EcsResourceRequirementType_Values returns all elements of the EcsResourceRequirementType enum +func EcsResourceRequirementType_Values() []string { + return []string{ + EcsResourceRequirementTypeGpu, + EcsResourceRequirementTypeInferenceAccelerator, + } +} + +const ( + // KinesisStreamStartPositionTrimHorizon is a KinesisStreamStartPosition enum value + KinesisStreamStartPositionTrimHorizon = "TRIM_HORIZON" + + // KinesisStreamStartPositionLatest is a KinesisStreamStartPosition enum value + KinesisStreamStartPositionLatest = "LATEST" + + // KinesisStreamStartPositionAtTimestamp is a KinesisStreamStartPosition enum value + KinesisStreamStartPositionAtTimestamp = "AT_TIMESTAMP" +) + +// KinesisStreamStartPosition_Values returns all elements of the KinesisStreamStartPosition enum +func KinesisStreamStartPosition_Values() []string { + return []string{ + KinesisStreamStartPositionTrimHorizon, + KinesisStreamStartPositionLatest, + KinesisStreamStartPositionAtTimestamp, + } +} + +const ( + // LaunchTypeEc2 is a LaunchType enum value + LaunchTypeEc2 = "EC2" + + // LaunchTypeFargate is a LaunchType enum value + LaunchTypeFargate = "FARGATE" + + // LaunchTypeExternal is a LaunchType enum value + LaunchTypeExternal = "EXTERNAL" +) + +// LaunchType_Values returns all elements of the LaunchType enum +func LaunchType_Values() []string { + return []string{ + LaunchTypeEc2, + LaunchTypeFargate, + LaunchTypeExternal, + } +} + +const ( + // MSKStartPositionTrimHorizon is a MSKStartPosition enum value + MSKStartPositionTrimHorizon = "TRIM_HORIZON" + + // MSKStartPositionLatest is a MSKStartPosition enum value + MSKStartPositionLatest = "LATEST" +) + +// MSKStartPosition_Values returns all elements of the MSKStartPosition enum +func MSKStartPosition_Values() []string { + return []string{ + MSKStartPositionTrimHorizon, + MSKStartPositionLatest, + } +} + +const ( + // OnPartialBatchItemFailureStreamsAutomaticBisect is a OnPartialBatchItemFailureStreams enum value + OnPartialBatchItemFailureStreamsAutomaticBisect = "AUTOMATIC_BISECT" +) + +// OnPartialBatchItemFailureStreams_Values returns all elements of the OnPartialBatchItemFailureStreams enum +func OnPartialBatchItemFailureStreams_Values() []string { + return []string{ + OnPartialBatchItemFailureStreamsAutomaticBisect, + } +} + +const ( + // PipeStateRunning is a PipeState enum value + PipeStateRunning = "RUNNING" + + // PipeStateStopped is a PipeState enum value + PipeStateStopped = "STOPPED" + + // PipeStateCreating is a PipeState enum value + PipeStateCreating = "CREATING" + + // PipeStateUpdating is a PipeState enum value + PipeStateUpdating = "UPDATING" + + // PipeStateDeleting is a PipeState enum value + PipeStateDeleting = "DELETING" + + // PipeStateStarting is a PipeState enum value + PipeStateStarting = "STARTING" + + // PipeStateStopping is a PipeState enum value + PipeStateStopping = "STOPPING" + + // PipeStateCreateFailed is a PipeState enum value + PipeStateCreateFailed = "CREATE_FAILED" + + // PipeStateUpdateFailed is a PipeState enum value + PipeStateUpdateFailed = "UPDATE_FAILED" + + // PipeStateStartFailed is a PipeState enum value + PipeStateStartFailed = "START_FAILED" + + // PipeStateStopFailed is a PipeState enum value + PipeStateStopFailed = "STOP_FAILED" +) + +// PipeState_Values returns all elements of the PipeState enum +func PipeState_Values() []string { + return []string{ + PipeStateRunning, + PipeStateStopped, + PipeStateCreating, + PipeStateUpdating, + PipeStateDeleting, + PipeStateStarting, + PipeStateStopping, + PipeStateCreateFailed, + PipeStateUpdateFailed, + PipeStateStartFailed, + PipeStateStopFailed, + } +} + +const ( + // PipeTargetInvocationTypeRequestResponse is a PipeTargetInvocationType enum value + PipeTargetInvocationTypeRequestResponse = "REQUEST_RESPONSE" + + // PipeTargetInvocationTypeFireAndForget is a PipeTargetInvocationType enum value + PipeTargetInvocationTypeFireAndForget = "FIRE_AND_FORGET" +) + +// PipeTargetInvocationType_Values returns all elements of the PipeTargetInvocationType enum +func PipeTargetInvocationType_Values() []string { + return []string{ + PipeTargetInvocationTypeRequestResponse, + PipeTargetInvocationTypeFireAndForget, + } +} + +const ( + // PlacementConstraintTypeDistinctInstance is a PlacementConstraintType enum value + PlacementConstraintTypeDistinctInstance = "distinctInstance" + + // PlacementConstraintTypeMemberOf is a PlacementConstraintType enum value + PlacementConstraintTypeMemberOf = "memberOf" +) + +// PlacementConstraintType_Values returns all elements of the PlacementConstraintType enum +func PlacementConstraintType_Values() []string { + return []string{ + PlacementConstraintTypeDistinctInstance, + PlacementConstraintTypeMemberOf, + } +} + +const ( + // PlacementStrategyTypeRandom is a PlacementStrategyType enum value + PlacementStrategyTypeRandom = "random" + + // PlacementStrategyTypeSpread is a PlacementStrategyType enum value + PlacementStrategyTypeSpread = "spread" + + // PlacementStrategyTypeBinpack is a PlacementStrategyType enum value + PlacementStrategyTypeBinpack = "binpack" +) + +// PlacementStrategyType_Values returns all elements of the PlacementStrategyType enum +func PlacementStrategyType_Values() []string { + return []string{ + PlacementStrategyTypeRandom, + PlacementStrategyTypeSpread, + PlacementStrategyTypeBinpack, + } +} + +const ( + // PropagateTagsTaskDefinition is a PropagateTags enum value + PropagateTagsTaskDefinition = "TASK_DEFINITION" +) + +// PropagateTags_Values returns all elements of the PropagateTags enum +func PropagateTags_Values() []string { + return []string{ + PropagateTagsTaskDefinition, + } +} + +const ( + // RequestedPipeStateRunning is a RequestedPipeState enum value + RequestedPipeStateRunning = "RUNNING" + + // RequestedPipeStateStopped is a RequestedPipeState enum value + RequestedPipeStateStopped = "STOPPED" +) + +// RequestedPipeState_Values returns all elements of the RequestedPipeState enum +func RequestedPipeState_Values() []string { + return []string{ + RequestedPipeStateRunning, + RequestedPipeStateStopped, + } +} + +const ( + // RequestedPipeStateDescribeResponseRunning is a RequestedPipeStateDescribeResponse enum value + RequestedPipeStateDescribeResponseRunning = "RUNNING" + + // RequestedPipeStateDescribeResponseStopped is a RequestedPipeStateDescribeResponse enum value + RequestedPipeStateDescribeResponseStopped = "STOPPED" + + // RequestedPipeStateDescribeResponseDeleted is a RequestedPipeStateDescribeResponse enum value + RequestedPipeStateDescribeResponseDeleted = "DELETED" +) + +// RequestedPipeStateDescribeResponse_Values returns all elements of the RequestedPipeStateDescribeResponse enum +func RequestedPipeStateDescribeResponse_Values() []string { + return []string{ + RequestedPipeStateDescribeResponseRunning, + RequestedPipeStateDescribeResponseStopped, + RequestedPipeStateDescribeResponseDeleted, + } +} + +const ( + // SelfManagedKafkaStartPositionTrimHorizon is a SelfManagedKafkaStartPosition enum value + SelfManagedKafkaStartPositionTrimHorizon = "TRIM_HORIZON" + + // SelfManagedKafkaStartPositionLatest is a SelfManagedKafkaStartPosition enum value + SelfManagedKafkaStartPositionLatest = "LATEST" +) + +// SelfManagedKafkaStartPosition_Values returns all elements of the SelfManagedKafkaStartPosition enum +func SelfManagedKafkaStartPosition_Values() []string { + return []string{ + SelfManagedKafkaStartPositionTrimHorizon, + SelfManagedKafkaStartPositionLatest, + } +} diff --git a/service/pipes/doc.go b/service/pipes/doc.go new file mode 100644 index 00000000000..9df7bb077ae --- /dev/null +++ b/service/pipes/doc.go @@ -0,0 +1,33 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +// Package pipes provides the client and types for making API +// requests to Amazon EventBridge Pipes. +// +// Amazon EventBridge Pipes connects event sources to targets. Pipes reduces +// the need for specialized knowledge and integration code when developing event +// driven architectures. This helps ensures consistency across your company’s +// applications. With Pipes, the target can be any available EventBridge target. +// To set up a pipe, you select the event source, add optional event filtering, +// define optional enrichment, and select the target for the event data. +// +// See https://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07 for more information on this service. +// +// See pipes package documentation for more information. +// https://docs.aws.amazon.com/sdk-for-go/api/service/pipes/ +// +// # Using the Client +// +// To contact Amazon EventBridge Pipes with the SDK use the New function to create +// a new service client. With that client you can make API requests to the service. +// These clients are safe to use concurrently. +// +// See the SDK's documentation for more information on how to use the SDK. +// https://docs.aws.amazon.com/sdk-for-go/api/ +// +// See aws.Config documentation for more information on configuring SDK clients. +// https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config +// +// See the Amazon EventBridge Pipes client Pipes for more +// information on creating client for this service. +// https://docs.aws.amazon.com/sdk-for-go/api/service/pipes/#New +package pipes diff --git a/service/pipes/errors.go b/service/pipes/errors.go new file mode 100644 index 00000000000..ff044fde191 --- /dev/null +++ b/service/pipes/errors.go @@ -0,0 +1,55 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package pipes + +import ( + "github.com/aws/aws-sdk-go/private/protocol" +) + +const ( + + // ErrCodeConflictException for service response error code + // "ConflictException". + // + // An action you attempted resulted in an exception. + ErrCodeConflictException = "ConflictException" + + // ErrCodeInternalException for service response error code + // "InternalException". + // + // This exception occurs due to unexpected causes. + ErrCodeInternalException = "InternalException" + + // ErrCodeNotFoundException for service response error code + // "NotFoundException". + // + // An entity that you specified does not exist. + ErrCodeNotFoundException = "NotFoundException" + + // ErrCodeServiceQuotaExceededException for service response error code + // "ServiceQuotaExceededException". + // + // A quota has been exceeded. + ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException" + + // ErrCodeThrottlingException for service response error code + // "ThrottlingException". + // + // An action was throttled. + ErrCodeThrottlingException = "ThrottlingException" + + // ErrCodeValidationException for service response error code + // "ValidationException". + // + // Indicates that an error has occurred while performing a validate operation. + ErrCodeValidationException = "ValidationException" +) + +var exceptionFromCode = map[string]func(protocol.ResponseMetadata) error{ + "ConflictException": newErrorConflictException, + "InternalException": newErrorInternalException, + "NotFoundException": newErrorNotFoundException, + "ServiceQuotaExceededException": newErrorServiceQuotaExceededException, + "ThrottlingException": newErrorThrottlingException, + "ValidationException": newErrorValidationException, +} diff --git a/service/pipes/pipesiface/interface.go b/service/pipes/pipesiface/interface.go new file mode 100644 index 00000000000..de5ba2f5ab3 --- /dev/null +++ b/service/pipes/pipesiface/interface.go @@ -0,0 +1,107 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +// Package pipesiface provides an interface to enable mocking the Amazon EventBridge Pipes service client +// for testing your code. +// +// It is important to note that this interface will have breaking changes +// when the service model is updated and adds new API operations, paginators, +// and waiters. +package pipesiface + +import ( + "github.com/aws/aws-sdk-go/aws" + "github.com/aws/aws-sdk-go/aws/request" + "github.com/aws/aws-sdk-go/service/pipes" +) + +// PipesAPI provides an interface to enable mocking the +// pipes.Pipes service client's API operation, +// paginators, and waiters. This make unit testing your code that calls out +// to the SDK's service client's calls easier. +// +// The best way to use this interface is so the SDK's service client's calls +// can be stubbed out for unit testing your code with the SDK without needing +// to inject custom request handlers into the SDK's request pipeline. +// +// // myFunc uses an SDK service client to make a request to +// // Amazon EventBridge Pipes. +// func myFunc(svc pipesiface.PipesAPI) bool { +// // Make svc.CreatePipe request +// } +// +// func main() { +// sess := session.New() +// svc := pipes.New(sess) +// +// myFunc(svc) +// } +// +// In your _test.go file: +// +// // Define a mock struct to be used in your unit tests of myFunc. +// type mockPipesClient struct { +// pipesiface.PipesAPI +// } +// func (m *mockPipesClient) CreatePipe(input *pipes.CreatePipeInput) (*pipes.CreatePipeOutput, error) { +// // mock response/functionality +// } +// +// func TestMyFunc(t *testing.T) { +// // Setup Test +// mockSvc := &mockPipesClient{} +// +// myfunc(mockSvc) +// +// // Verify myFunc's functionality +// } +// +// It is important to note that this interface will have breaking changes +// when the service model is updated and adds new API operations, paginators, +// and waiters. Its suggested to use the pattern above for testing, or using +// tooling to generate mocks to satisfy the interfaces. +type PipesAPI interface { + CreatePipe(*pipes.CreatePipeInput) (*pipes.CreatePipeOutput, error) + CreatePipeWithContext(aws.Context, *pipes.CreatePipeInput, ...request.Option) (*pipes.CreatePipeOutput, error) + CreatePipeRequest(*pipes.CreatePipeInput) (*request.Request, *pipes.CreatePipeOutput) + + DeletePipe(*pipes.DeletePipeInput) (*pipes.DeletePipeOutput, error) + DeletePipeWithContext(aws.Context, *pipes.DeletePipeInput, ...request.Option) (*pipes.DeletePipeOutput, error) + DeletePipeRequest(*pipes.DeletePipeInput) (*request.Request, *pipes.DeletePipeOutput) + + DescribePipe(*pipes.DescribePipeInput) (*pipes.DescribePipeOutput, error) + DescribePipeWithContext(aws.Context, *pipes.DescribePipeInput, ...request.Option) (*pipes.DescribePipeOutput, error) + DescribePipeRequest(*pipes.DescribePipeInput) (*request.Request, *pipes.DescribePipeOutput) + + ListPipes(*pipes.ListPipesInput) (*pipes.ListPipesOutput, error) + ListPipesWithContext(aws.Context, *pipes.ListPipesInput, ...request.Option) (*pipes.ListPipesOutput, error) + ListPipesRequest(*pipes.ListPipesInput) (*request.Request, *pipes.ListPipesOutput) + + ListPipesPages(*pipes.ListPipesInput, func(*pipes.ListPipesOutput, bool) bool) error + ListPipesPagesWithContext(aws.Context, *pipes.ListPipesInput, func(*pipes.ListPipesOutput, bool) bool, ...request.Option) error + + ListTagsForResource(*pipes.ListTagsForResourceInput) (*pipes.ListTagsForResourceOutput, error) + ListTagsForResourceWithContext(aws.Context, *pipes.ListTagsForResourceInput, ...request.Option) (*pipes.ListTagsForResourceOutput, error) + ListTagsForResourceRequest(*pipes.ListTagsForResourceInput) (*request.Request, *pipes.ListTagsForResourceOutput) + + StartPipe(*pipes.StartPipeInput) (*pipes.StartPipeOutput, error) + StartPipeWithContext(aws.Context, *pipes.StartPipeInput, ...request.Option) (*pipes.StartPipeOutput, error) + StartPipeRequest(*pipes.StartPipeInput) (*request.Request, *pipes.StartPipeOutput) + + StopPipe(*pipes.StopPipeInput) (*pipes.StopPipeOutput, error) + StopPipeWithContext(aws.Context, *pipes.StopPipeInput, ...request.Option) (*pipes.StopPipeOutput, error) + StopPipeRequest(*pipes.StopPipeInput) (*request.Request, *pipes.StopPipeOutput) + + TagResource(*pipes.TagResourceInput) (*pipes.TagResourceOutput, error) + TagResourceWithContext(aws.Context, *pipes.TagResourceInput, ...request.Option) (*pipes.TagResourceOutput, error) + TagResourceRequest(*pipes.TagResourceInput) (*request.Request, *pipes.TagResourceOutput) + + UntagResource(*pipes.UntagResourceInput) (*pipes.UntagResourceOutput, error) + UntagResourceWithContext(aws.Context, *pipes.UntagResourceInput, ...request.Option) (*pipes.UntagResourceOutput, error) + UntagResourceRequest(*pipes.UntagResourceInput) (*request.Request, *pipes.UntagResourceOutput) + + UpdatePipe(*pipes.UpdatePipeInput) (*pipes.UpdatePipeOutput, error) + UpdatePipeWithContext(aws.Context, *pipes.UpdatePipeInput, ...request.Option) (*pipes.UpdatePipeOutput, error) + UpdatePipeRequest(*pipes.UpdatePipeInput) (*request.Request, *pipes.UpdatePipeOutput) +} + +var _ PipesAPI = (*pipes.Pipes)(nil) diff --git a/service/pipes/service.go b/service/pipes/service.go new file mode 100644 index 00000000000..517dac356ac --- /dev/null +++ b/service/pipes/service.go @@ -0,0 +1,106 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package pipes + +import ( + "github.com/aws/aws-sdk-go/aws" + "github.com/aws/aws-sdk-go/aws/client" + "github.com/aws/aws-sdk-go/aws/client/metadata" + "github.com/aws/aws-sdk-go/aws/request" + "github.com/aws/aws-sdk-go/aws/signer/v4" + "github.com/aws/aws-sdk-go/private/protocol" + "github.com/aws/aws-sdk-go/private/protocol/restjson" +) + +// Pipes provides the API operation methods for making requests to +// Amazon EventBridge Pipes. See this package's package overview docs +// for details on the service. +// +// Pipes methods are safe to use concurrently. It is not safe to +// modify mutate any of the struct's properties though. +type Pipes struct { + *client.Client +} + +// Used for custom client initialization logic +var initClient func(*client.Client) + +// Used for custom request initialization logic +var initRequest func(*request.Request) + +// Service information constants +const ( + ServiceName = "Pipes" // Name of service. + EndpointsID = "pipes" // ID to lookup a service endpoint with. + ServiceID = "Pipes" // ServiceID is a unique identifier of a specific service. +) + +// New creates a new instance of the Pipes client with a session. +// If additional configuration is needed for the client instance use the optional +// aws.Config parameter to add your extra config. +// +// Example: +// +// mySession := session.Must(session.NewSession()) +// +// // Create a Pipes client from just a session. +// svc := pipes.New(mySession) +// +// // Create a Pipes client with additional configuration +// svc := pipes.New(mySession, aws.NewConfig().WithRegion("us-west-2")) +func New(p client.ConfigProvider, cfgs ...*aws.Config) *Pipes { + c := p.ClientConfig(EndpointsID, cfgs...) + if c.SigningNameDerived || len(c.SigningName) == 0 { + c.SigningName = "pipes" + } + return newClient(*c.Config, c.Handlers, c.PartitionID, c.Endpoint, c.SigningRegion, c.SigningName, c.ResolvedRegion) +} + +// newClient creates, initializes and returns a new service client instance. +func newClient(cfg aws.Config, handlers request.Handlers, partitionID, endpoint, signingRegion, signingName, resolvedRegion string) *Pipes { + svc := &Pipes{ + Client: client.New( + cfg, + metadata.ClientInfo{ + ServiceName: ServiceName, + ServiceID: ServiceID, + SigningName: signingName, + SigningRegion: signingRegion, + PartitionID: partitionID, + Endpoint: endpoint, + APIVersion: "2015-10-07", + ResolvedRegion: resolvedRegion, + }, + handlers, + ), + } + + // Handlers + svc.Handlers.Sign.PushBackNamed(v4.SignRequestHandler) + svc.Handlers.Build.PushBackNamed(restjson.BuildHandler) + svc.Handlers.Unmarshal.PushBackNamed(restjson.UnmarshalHandler) + svc.Handlers.UnmarshalMeta.PushBackNamed(restjson.UnmarshalMetaHandler) + svc.Handlers.UnmarshalError.PushBackNamed( + protocol.NewUnmarshalErrorHandler(restjson.NewUnmarshalTypedError(exceptionFromCode)).NamedHandler(), + ) + + // Run custom client initialization if present + if initClient != nil { + initClient(svc.Client) + } + + return svc +} + +// newRequest creates a new request for a Pipes operation and runs any +// custom request initialization. +func (c *Pipes) newRequest(op *request.Operation, params, data interface{}) *request.Request { + req := c.NewRequest(op, params, data) + + // Run custom request initialization if present + if initRequest != nil { + initRequest(req) + } + + return req +} diff --git a/service/sfn/api.go b/service/sfn/api.go index 6b49183417b..5d91a43d7d4 100644 --- a/service/sfn/api.go +++ b/service/sfn/api.go @@ -87,7 +87,7 @@ func (c *SFN) CreateActivityRequest(input *CreateActivityInput) (req *request.Re // be deleted before a new activity can be created. // // - InvalidName -// The provided name is invalid. +// The provided name is not valid. // // - TooManyTags // You've exceeded the number of tags allowed for a resource. See the Limits @@ -187,13 +187,13 @@ func (c *SFN) CreateStateMachineRequest(input *CreateStateMachineInput) (req *re // Returned Error Types: // // - InvalidArn -// The provided Amazon Resource Name (ARN) is invalid. +// The provided Amazon Resource Name (ARN) is not valid. // // - InvalidDefinition -// The provided Amazon States Language definition is invalid. +// The provided Amazon States Language definition is not valid. // // - InvalidName -// The provided name is invalid. +// The provided name is not valid. // // - InvalidLoggingConfiguration // @@ -296,7 +296,7 @@ func (c *SFN) DeleteActivityRequest(input *DeleteActivityInput) (req *request.Re // // Returned Error Types: // - InvalidArn -// The provided Amazon Resource Name (ARN) is invalid. +// The provided Amazon Resource Name (ARN) is not valid. // // See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DeleteActivity func (c *SFN) DeleteActivity(input *DeleteActivityInput) (*DeleteActivityOutput, error) { @@ -367,6 +367,14 @@ func (c *SFN) DeleteStateMachineRequest(input *DeleteStateMachineInput) (req *re // Deletes a state machine. This is an asynchronous operation: It sets the state // machine's status to DELETING and begins the deletion process. // +// If the given state machine Amazon Resource Name (ARN) is a qualified state +// machine ARN, it will fail with ValidationException. +// +// A qualified state machine ARN refers to a Distributed Map state defined within +// a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel +// refers to a Distributed Map state with a label mapStateLabel in the state +// machine named stateMachineName. +// // For EXPRESS state machines, the deletion will happen eventually (usually // less than a minute). Running executions may emit logs after DeleteStateMachine // API is called. @@ -379,8 +387,13 @@ func (c *SFN) DeleteStateMachineRequest(input *DeleteStateMachineInput) (req *re // API operation DeleteStateMachine for usage and error information. // // Returned Error Types: +// // - InvalidArn -// The provided Amazon Resource Name (ARN) is invalid. +// The provided Amazon Resource Name (ARN) is not valid. +// +// - ValidationException +// The input does not satisfy the constraints specified by an Amazon Web Services +// service. // // See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DeleteStateMachine func (c *SFN) DeleteStateMachine(input *DeleteStateMachineInput) (*DeleteStateMachineOutput, error) { @@ -465,7 +478,7 @@ func (c *SFN) DescribeActivityRequest(input *DescribeActivityInput) (req *reques // The specified activity does not exist. // // - InvalidArn -// The provided Amazon Resource Name (ARN) is invalid. +// The provided Amazon Resource Name (ARN) is not valid. // // See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeActivity func (c *SFN) DescribeActivity(input *DescribeActivityInput) (*DescribeActivityOutput, error) { @@ -532,12 +545,16 @@ func (c *SFN) DescribeExecutionRequest(input *DescribeExecutionInput) (req *requ // DescribeExecution API operation for AWS Step Functions. // -// Describes an execution. +// Provides all information about a state machine execution, such as the state +// machine associated with the execution, the execution input and output, and +// relevant execution metadata. Use this API action to return the Map Run ARN +// if the execution was dispatched by a Map Run. // // This operation is eventually consistent. The results are best effort and // may not reflect very recent updates and changes. // -// This API action is not supported by EXPRESS state machines. +// This API action is not supported by EXPRESS state machine executions unless +// they were dispatched by a Map Run. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -552,7 +569,7 @@ func (c *SFN) DescribeExecutionRequest(input *DescribeExecutionInput) (req *requ // The specified execution does not exist. // // - InvalidArn -// The provided Amazon Resource Name (ARN) is invalid. +// The provided Amazon Resource Name (ARN) is not valid. // // See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeExecution func (c *SFN) DescribeExecution(input *DescribeExecutionInput) (*DescribeExecutionOutput, error) { @@ -576,6 +593,91 @@ func (c *SFN) DescribeExecutionWithContext(ctx aws.Context, input *DescribeExecu return out, req.Send() } +const opDescribeMapRun = "DescribeMapRun" + +// DescribeMapRunRequest generates a "aws/request.Request" representing the +// client's request for the DescribeMapRun operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribeMapRun for more information on using the DescribeMapRun +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the DescribeMapRunRequest method. +// req, resp := client.DescribeMapRunRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeMapRun +func (c *SFN) DescribeMapRunRequest(input *DescribeMapRunInput) (req *request.Request, output *DescribeMapRunOutput) { + op := &request.Operation{ + Name: opDescribeMapRun, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DescribeMapRunInput{} + } + + output = &DescribeMapRunOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeMapRun API operation for AWS Step Functions. +// +// Provides information about a Map Run's configuration, progress, and results. +// For more information, see Examining Map Run (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-examine-map-run.html) +// in the Step Functions Developer Guide. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Step Functions's +// API operation DescribeMapRun for usage and error information. +// +// Returned Error Types: +// +// - ResourceNotFound +// Could not find the referenced resource. Only state machine and activity ARNs +// are supported. +// +// - InvalidArn +// The provided Amazon Resource Name (ARN) is not valid. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeMapRun +func (c *SFN) DescribeMapRun(input *DescribeMapRunInput) (*DescribeMapRunOutput, error) { + req, out := c.DescribeMapRunRequest(input) + return out, req.Send() +} + +// DescribeMapRunWithContext is the same as DescribeMapRun with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeMapRun for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *SFN) DescribeMapRunWithContext(ctx aws.Context, input *DescribeMapRunInput, opts ...request.Option) (*DescribeMapRunOutput, error) { + req, out := c.DescribeMapRunRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDescribeStateMachine = "DescribeStateMachine" // DescribeStateMachineRequest generates a "aws/request.Request" representing the @@ -619,7 +721,14 @@ func (c *SFN) DescribeStateMachineRequest(input *DescribeStateMachineInput) (req // DescribeStateMachine API operation for AWS Step Functions. // -// Describes a state machine. +// Provides information about a state machine's definition, its IAM role Amazon +// Resource Name (ARN), and configuration. If the state machine ARN is a qualified +// state machine ARN, the response returned includes the Map state's label. +// +// A qualified state machine ARN refers to a Distributed Map state defined within +// a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel +// refers to a Distributed Map state with a label mapStateLabel in the state +// machine named stateMachineName. // // This operation is eventually consistent. The results are best effort and // may not reflect very recent updates and changes. @@ -634,7 +743,7 @@ func (c *SFN) DescribeStateMachineRequest(input *DescribeStateMachineInput) (req // Returned Error Types: // // - InvalidArn -// The provided Amazon Resource Name (ARN) is invalid. +// The provided Amazon Resource Name (ARN) is not valid. // // - StateMachineDoesNotExist // The specified state machine does not exist. @@ -704,7 +813,10 @@ func (c *SFN) DescribeStateMachineForExecutionRequest(input *DescribeStateMachin // DescribeStateMachineForExecution API operation for AWS Step Functions. // -// Describes the state machine associated with a specific execution. +// Provides information about a state machine's definition, its execution role +// ARN, and configuration. If an execution was dispatched by a Map Run, the +// Map Run is returned in the response. Additionally, the state machine returned +// will be the state machine associated with the Map Run. // // This operation is eventually consistent. The results are best effort and // may not reflect very recent updates and changes. @@ -724,7 +836,7 @@ func (c *SFN) DescribeStateMachineForExecutionRequest(input *DescribeStateMachin // The specified execution does not exist. // // - InvalidArn -// The provided Amazon Resource Name (ARN) is invalid. +// The provided Amazon Resource Name (ARN) is not valid. // // See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeStateMachineForExecution func (c *SFN) DescribeStateMachineForExecution(input *DescribeStateMachineForExecutionInput) (*DescribeStateMachineForExecutionOutput, error) { @@ -825,7 +937,7 @@ func (c *SFN) GetActivityTaskRequest(input *GetActivityTaskInput) (req *request. // been reached. // // - InvalidArn -// The provided Amazon Resource Name (ARN) is invalid. +// The provided Amazon Resource Name (ARN) is not valid. // // See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/GetActivityTask func (c *SFN) GetActivityTask(input *GetActivityTaskInput) (*GetActivityTaskOutput, error) { @@ -923,10 +1035,10 @@ func (c *SFN) GetExecutionHistoryRequest(input *GetExecutionHistoryInput) (req * // The specified execution does not exist. // // - InvalidArn -// The provided Amazon Resource Name (ARN) is invalid. +// The provided Amazon Resource Name (ARN) is not valid. // // - InvalidToken -// The provided token is invalid. +// The provided token is not valid. // // See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/GetExecutionHistory func (c *SFN) GetExecutionHistory(input *GetExecutionHistoryInput) (*GetExecutionHistoryOutput, error) { @@ -1070,7 +1182,7 @@ func (c *SFN) ListActivitiesRequest(input *ListActivitiesInput) (req *request.Re // // Returned Error Types: // - InvalidToken -// The provided token is invalid. +// The provided token is not valid. // // See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListActivities func (c *SFN) ListActivities(input *ListActivitiesInput) (*ListActivitiesOutput, error) { @@ -1194,7 +1306,10 @@ func (c *SFN) ListExecutionsRequest(input *ListExecutionsInput) (req *request.Re // ListExecutions API operation for AWS Step Functions. // -// Lists the executions of a state machine that meet the filtering criteria. +// Lists all executions of a state machine or a Map Run. You can list all executions +// related to a state machine by specifying a state machine Amazon Resource +// Name (ARN), or those related to a Map Run by specifying a Map Run ARN. +// // Results are sorted by time, with the most recent execution first. // // If nextToken is returned, there are more results available. The value of @@ -1218,16 +1333,24 @@ func (c *SFN) ListExecutionsRequest(input *ListExecutionsInput) (req *request.Re // Returned Error Types: // // - InvalidArn -// The provided Amazon Resource Name (ARN) is invalid. +// The provided Amazon Resource Name (ARN) is not valid. // // - InvalidToken -// The provided token is invalid. +// The provided token is not valid. // // - StateMachineDoesNotExist // The specified state machine does not exist. // // - StateMachineTypeNotSupported // +// - ValidationException +// The input does not satisfy the constraints specified by an Amazon Web Services +// service. +// +// - ResourceNotFound +// Could not find the referenced resource. Only state machine and activity ARNs +// are supported. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListExecutions func (c *SFN) ListExecutions(input *ListExecutionsInput) (*ListExecutionsOutput, error) { req, out := c.ListExecutionsRequest(input) @@ -1301,6 +1424,150 @@ func (c *SFN) ListExecutionsPagesWithContext(ctx aws.Context, input *ListExecuti return p.Err() } +const opListMapRuns = "ListMapRuns" + +// ListMapRunsRequest generates a "aws/request.Request" representing the +// client's request for the ListMapRuns operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListMapRuns for more information on using the ListMapRuns +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the ListMapRunsRequest method. +// req, resp := client.ListMapRunsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListMapRuns +func (c *SFN) ListMapRunsRequest(input *ListMapRunsInput) (req *request.Request, output *ListMapRunsOutput) { + op := &request.Operation{ + Name: opListMapRuns, + HTTPMethod: "POST", + HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListMapRunsInput{} + } + + output = &ListMapRunsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListMapRuns API operation for AWS Step Functions. +// +// Lists all Map Runs that were started by a given state machine execution. +// Use this API action to obtain Map Run ARNs, and then call DescribeMapRun +// to obtain more information, if needed. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Step Functions's +// API operation ListMapRuns for usage and error information. +// +// Returned Error Types: +// +// - ExecutionDoesNotExist +// The specified execution does not exist. +// +// - InvalidArn +// The provided Amazon Resource Name (ARN) is not valid. +// +// - InvalidToken +// The provided token is not valid. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListMapRuns +func (c *SFN) ListMapRuns(input *ListMapRunsInput) (*ListMapRunsOutput, error) { + req, out := c.ListMapRunsRequest(input) + return out, req.Send() +} + +// ListMapRunsWithContext is the same as ListMapRuns with the addition of +// the ability to pass a context and additional request options. +// +// See ListMapRuns for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *SFN) ListMapRunsWithContext(ctx aws.Context, input *ListMapRunsInput, opts ...request.Option) (*ListMapRunsOutput, error) { + req, out := c.ListMapRunsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListMapRunsPages iterates over the pages of a ListMapRuns operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListMapRuns method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListMapRuns operation. +// pageNum := 0 +// err := client.ListMapRunsPages(params, +// func(page *sfn.ListMapRunsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +func (c *SFN) ListMapRunsPages(input *ListMapRunsInput, fn func(*ListMapRunsOutput, bool) bool) error { + return c.ListMapRunsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListMapRunsPagesWithContext same as ListMapRunsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *SFN) ListMapRunsPagesWithContext(ctx aws.Context, input *ListMapRunsInput, fn func(*ListMapRunsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListMapRunsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListMapRunsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListMapRunsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opListStateMachines = "ListStateMachines" // ListStateMachinesRequest generates a "aws/request.Request" representing the @@ -1370,7 +1637,7 @@ func (c *SFN) ListStateMachinesRequest(input *ListStateMachinesInput) (req *requ // // Returned Error Types: // - InvalidToken -// The provided token is invalid. +// The provided token is not valid. // // See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListStateMachines func (c *SFN) ListStateMachines(input *ListStateMachinesInput) (*ListStateMachinesOutput, error) { @@ -1503,7 +1770,7 @@ func (c *SFN) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req * // Returned Error Types: // // - InvalidArn -// The provided Amazon Resource Name (ARN) is invalid. +// The provided Amazon Resource Name (ARN) is not valid. // // - ResourceNotFound // Could not find the referenced resource. Only state machine and activity ARNs @@ -1590,7 +1857,7 @@ func (c *SFN) SendTaskFailureRequest(input *SendTaskFailureInput) (req *request. // - TaskDoesNotExist // // - InvalidToken -// The provided token is invalid. +// The provided token is not valid. // // - TaskTimedOut // @@ -1688,7 +1955,7 @@ func (c *SFN) SendTaskHeartbeatRequest(input *SendTaskHeartbeatInput) (req *requ // - TaskDoesNotExist // // - InvalidToken -// The provided token is invalid. +// The provided token is not valid. // // - TaskTimedOut // @@ -1773,10 +2040,10 @@ func (c *SFN) SendTaskSuccessRequest(input *SendTaskSuccessInput) (req *request. // - TaskDoesNotExist // // - InvalidOutput -// The provided JSON output data is invalid. +// The provided JSON output data is not valid. // // - InvalidToken -// The provided token is invalid. +// The provided token is not valid. // // - TaskTimedOut // @@ -1845,7 +2112,13 @@ func (c *SFN) StartExecutionRequest(input *StartExecutionInput) (req *request.Re // StartExecution API operation for AWS Step Functions. // -// Starts a state machine execution. +// Starts a state machine execution. If the given state machine Amazon Resource +// Name (ARN) is a qualified state machine ARN, it will fail with ValidationException. +// +// A qualified state machine ARN refers to a Distributed Map state defined within +// a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel +// refers to a Distributed Map state with a label mapStateLabel in the state +// machine named stateMachineName. // // StartExecution is idempotent for STANDARD workflows. For a STANDARD workflow, // if StartExecution is called with the same name and input as a running execution, @@ -1874,13 +2147,13 @@ func (c *SFN) StartExecutionRequest(input *StartExecutionInput) (req *request.Re // Executions with the same name and input are considered idempotent. // // - InvalidArn -// The provided Amazon Resource Name (ARN) is invalid. +// The provided Amazon Resource Name (ARN) is not valid. // // - InvalidExecutionInput -// The provided JSON input data is invalid. +// The provided JSON input data is not valid. // // - InvalidName -// The provided name is invalid. +// The provided name is not valid. // // - StateMachineDoesNotExist // The specified state machine does not exist. @@ -1888,6 +2161,10 @@ func (c *SFN) StartExecutionRequest(input *StartExecutionInput) (req *request.Re // - StateMachineDeleting // The specified state machine is being deleted. // +// - ValidationException +// The input does not satisfy the constraints specified by an Amazon Web Services +// service. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StartExecution func (c *SFN) StartExecution(input *StartExecutionInput) (*StartExecutionOutput, error) { req, out := c.StartExecutionRequest(input) @@ -1976,13 +2253,13 @@ func (c *SFN) StartSyncExecutionRequest(input *StartSyncExecutionInput) (req *re // Returned Error Types: // // - InvalidArn -// The provided Amazon Resource Name (ARN) is invalid. +// The provided Amazon Resource Name (ARN) is not valid. // // - InvalidExecutionInput -// The provided JSON input data is invalid. +// The provided JSON input data is not valid. // // - InvalidName -// The provided name is invalid. +// The provided name is not valid. // // - StateMachineDoesNotExist // The specified state machine does not exist. @@ -2074,7 +2351,11 @@ func (c *SFN) StopExecutionRequest(input *StopExecutionInput) (req *request.Requ // The specified execution does not exist. // // - InvalidArn -// The provided Amazon Resource Name (ARN) is invalid. +// The provided Amazon Resource Name (ARN) is not valid. +// +// - ValidationException +// The input does not satisfy the constraints specified by an Amazon Web Services +// service. // // See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StopExecution func (c *SFN) StopExecution(input *StopExecutionInput) (*StopExecutionOutput, error) { @@ -2162,7 +2443,7 @@ func (c *SFN) TagResourceRequest(input *TagResourceInput) (req *request.Request, // Returned Error Types: // // - InvalidArn -// The provided Amazon Resource Name (ARN) is invalid. +// The provided Amazon Resource Name (ARN) is not valid. // // - ResourceNotFound // Could not find the referenced resource. Only state machine and activity ARNs @@ -2251,7 +2532,7 @@ func (c *SFN) UntagResourceRequest(input *UntagResourceInput) (req *request.Requ // Returned Error Types: // // - InvalidArn -// The provided Amazon Resource Name (ARN) is invalid. +// The provided Amazon Resource Name (ARN) is not valid. // // - ResourceNotFound // Could not find the referenced resource. Only state machine and activity ARNs @@ -2279,6 +2560,95 @@ func (c *SFN) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInpu return out, req.Send() } +const opUpdateMapRun = "UpdateMapRun" + +// UpdateMapRunRequest generates a "aws/request.Request" representing the +// client's request for the UpdateMapRun operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UpdateMapRun for more information on using the UpdateMapRun +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the UpdateMapRunRequest method. +// req, resp := client.UpdateMapRunRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/UpdateMapRun +func (c *SFN) UpdateMapRunRequest(input *UpdateMapRunInput) (req *request.Request, output *UpdateMapRunOutput) { + op := &request.Operation{ + Name: opUpdateMapRun, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &UpdateMapRunInput{} + } + + output = &UpdateMapRunOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// UpdateMapRun API operation for AWS Step Functions. +// +// Updates an in-progress Map Run's configuration to include changes to the +// settings that control maximum concurrency and Map Run failure. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Step Functions's +// API operation UpdateMapRun for usage and error information. +// +// Returned Error Types: +// +// - ResourceNotFound +// Could not find the referenced resource. Only state machine and activity ARNs +// are supported. +// +// - InvalidArn +// The provided Amazon Resource Name (ARN) is not valid. +// +// - ValidationException +// The input does not satisfy the constraints specified by an Amazon Web Services +// service. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/UpdateMapRun +func (c *SFN) UpdateMapRun(input *UpdateMapRunInput) (*UpdateMapRunOutput, error) { + req, out := c.UpdateMapRunRequest(input) + return out, req.Send() +} + +// UpdateMapRunWithContext is the same as UpdateMapRun with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateMapRun for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *SFN) UpdateMapRunWithContext(ctx aws.Context, input *UpdateMapRunInput, opts ...request.Option) (*UpdateMapRunOutput, error) { + req, out := c.UpdateMapRunRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opUpdateStateMachine = "UpdateStateMachine" // UpdateStateMachineRequest generates a "aws/request.Request" representing the @@ -2327,6 +2697,14 @@ func (c *SFN) UpdateStateMachineRequest(input *UpdateStateMachineInput) (req *re // definition and roleArn. You must include at least one of definition or roleArn // or you will receive a MissingRequiredParameter error. // +// If the given state machine Amazon Resource Name (ARN) is a qualified state +// machine ARN, it will fail with ValidationException. +// +// A qualified state machine ARN refers to a Distributed Map state defined within +// a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel +// refers to a Distributed Map state with a label mapStateLabel in the state +// machine named stateMachineName. +// // All StartExecution calls within a few seconds will use the updated definition // and roleArn. Executions started immediately after calling UpdateStateMachine // may use the previous state machine definition and roleArn. @@ -2341,10 +2719,10 @@ func (c *SFN) UpdateStateMachineRequest(input *UpdateStateMachineInput) (req *re // Returned Error Types: // // - InvalidArn -// The provided Amazon Resource Name (ARN) is invalid. +// The provided Amazon Resource Name (ARN) is not valid. // // - InvalidDefinition -// The provided Amazon States Language definition is invalid. +// The provided Amazon States Language definition is not valid. // // - InvalidLoggingConfiguration // @@ -2362,6 +2740,10 @@ func (c *SFN) UpdateStateMachineRequest(input *UpdateStateMachineInput) (req *re // - StateMachineDoesNotExist // The specified state machine does not exist. // +// - ValidationException +// The input does not satisfy the constraints specified by an Amazon Web Services +// service. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/UpdateStateMachine func (c *SFN) UpdateStateMachine(input *UpdateStateMachineInput) (*UpdateStateMachineOutput, error) { req, out := c.UpdateStateMachineRequest(input) @@ -3734,13 +4116,27 @@ func (s *DescribeExecutionInput) SetExecutionArn(v string) *DescribeExecutionInp type DescribeExecutionOutput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) that identifies the execution. + // The cause string if the state machine execution failed. // - // ExecutionArn is a required field - ExecutionArn *string `locationName:"executionArn" min:"1" type:"string" required:"true"` - - // The string that contains the JSON input data of the execution. Length constraints - // apply to the payload size, and are expressed as bytes in UTF-8 encoding. + // Cause is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by DescribeExecutionOutput's + // String and GoString methods. + Cause *string `locationName:"cause" type:"string" sensitive:"true"` + + // The error string if the state machine execution failed. + // + // Error is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by DescribeExecutionOutput's + // String and GoString methods. + Error *string `locationName:"error" type:"string" sensitive:"true"` + + // The Amazon Resource Name (ARN) that identifies the execution. + // + // ExecutionArn is a required field + ExecutionArn *string `locationName:"executionArn" min:"1" type:"string" required:"true"` + + // The string that contains the JSON input data of the execution. Length constraints + // apply to the payload size, and are expressed as bytes in UTF-8 encoding. // // Input is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by DescribeExecutionOutput's @@ -3750,6 +4146,10 @@ type DescribeExecutionOutput struct { // Provides details about execution input or output. InputDetails *CloudWatchEventsExecutionDataDetails `locationName:"inputDetails" type:"structure"` + // The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched + // this execution. + MapRunArn *string `locationName:"mapRunArn" min:"1" type:"string"` + // The name of the execution. // // A name must not contain: @@ -3822,6 +4222,18 @@ func (s DescribeExecutionOutput) GoString() string { return s.String() } +// SetCause sets the Cause field's value. +func (s *DescribeExecutionOutput) SetCause(v string) *DescribeExecutionOutput { + s.Cause = &v + return s +} + +// SetError sets the Error field's value. +func (s *DescribeExecutionOutput) SetError(v string) *DescribeExecutionOutput { + s.Error = &v + return s +} + // SetExecutionArn sets the ExecutionArn field's value. func (s *DescribeExecutionOutput) SetExecutionArn(v string) *DescribeExecutionOutput { s.ExecutionArn = &v @@ -3840,6 +4252,12 @@ func (s *DescribeExecutionOutput) SetInputDetails(v *CloudWatchEventsExecutionDa return s } +// SetMapRunArn sets the MapRunArn field's value. +func (s *DescribeExecutionOutput) SetMapRunArn(v string) *DescribeExecutionOutput { + s.MapRunArn = &v + return s +} + // SetName sets the Name field's value. func (s *DescribeExecutionOutput) SetName(v string) *DescribeExecutionOutput { s.Name = &v @@ -3888,6 +4306,192 @@ func (s *DescribeExecutionOutput) SetTraceHeader(v string) *DescribeExecutionOut return s } +type DescribeMapRunInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) that identifies a Map Run. + // + // MapRunArn is a required field + MapRunArn *string `locationName:"mapRunArn" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeMapRunInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeMapRunInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeMapRunInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeMapRunInput"} + if s.MapRunArn == nil { + invalidParams.Add(request.NewErrParamRequired("MapRunArn")) + } + if s.MapRunArn != nil && len(*s.MapRunArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("MapRunArn", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMapRunArn sets the MapRunArn field's value. +func (s *DescribeMapRunInput) SetMapRunArn(v string) *DescribeMapRunInput { + s.MapRunArn = &v + return s +} + +type DescribeMapRunOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) that identifies the execution in which the + // Map Run was started. + // + // ExecutionArn is a required field + ExecutionArn *string `locationName:"executionArn" min:"1" type:"string" required:"true"` + + // A JSON object that contains information about the total number of child workflow + // executions for the Map Run, and the count of child workflow executions for + // each status, such as failed and succeeded. + // + // ExecutionCounts is a required field + ExecutionCounts *MapRunExecutionCounts `locationName:"executionCounts" type:"structure" required:"true"` + + // A JSON object that contains information about the total number of items, + // and the item count for each processing status, such as pending and failed. + // + // ItemCounts is a required field + ItemCounts *MapRunItemCounts `locationName:"itemCounts" type:"structure" required:"true"` + + // The Amazon Resource Name (ARN) that identifies a Map Run. + // + // MapRunArn is a required field + MapRunArn *string `locationName:"mapRunArn" min:"1" type:"string" required:"true"` + + // The maximum number of child workflow executions configured to run in parallel + // for the Map Run at the same time. + // + // MaxConcurrency is a required field + MaxConcurrency *int64 `locationName:"maxConcurrency" type:"integer" required:"true"` + + // The date when the Map Run was started. + // + // StartDate is a required field + StartDate *time.Time `locationName:"startDate" type:"timestamp" required:"true"` + + // The current status of the Map Run. + // + // Status is a required field + Status *string `locationName:"status" type:"string" required:"true" enum:"MapRunStatus"` + + // The date when the Map Run was stopped. + StopDate *time.Time `locationName:"stopDate" type:"timestamp"` + + // The maximum number of failed child workflow executions before the Map Run + // fails. + // + // ToleratedFailureCount is a required field + ToleratedFailureCount *int64 `locationName:"toleratedFailureCount" type:"long" required:"true"` + + // The maximum percentage of failed child workflow executions before the Map + // Run fails. + // + // ToleratedFailurePercentage is a required field + ToleratedFailurePercentage *float64 `locationName:"toleratedFailurePercentage" type:"float" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeMapRunOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeMapRunOutput) GoString() string { + return s.String() +} + +// SetExecutionArn sets the ExecutionArn field's value. +func (s *DescribeMapRunOutput) SetExecutionArn(v string) *DescribeMapRunOutput { + s.ExecutionArn = &v + return s +} + +// SetExecutionCounts sets the ExecutionCounts field's value. +func (s *DescribeMapRunOutput) SetExecutionCounts(v *MapRunExecutionCounts) *DescribeMapRunOutput { + s.ExecutionCounts = v + return s +} + +// SetItemCounts sets the ItemCounts field's value. +func (s *DescribeMapRunOutput) SetItemCounts(v *MapRunItemCounts) *DescribeMapRunOutput { + s.ItemCounts = v + return s +} + +// SetMapRunArn sets the MapRunArn field's value. +func (s *DescribeMapRunOutput) SetMapRunArn(v string) *DescribeMapRunOutput { + s.MapRunArn = &v + return s +} + +// SetMaxConcurrency sets the MaxConcurrency field's value. +func (s *DescribeMapRunOutput) SetMaxConcurrency(v int64) *DescribeMapRunOutput { + s.MaxConcurrency = &v + return s +} + +// SetStartDate sets the StartDate field's value. +func (s *DescribeMapRunOutput) SetStartDate(v time.Time) *DescribeMapRunOutput { + s.StartDate = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *DescribeMapRunOutput) SetStatus(v string) *DescribeMapRunOutput { + s.Status = &v + return s +} + +// SetStopDate sets the StopDate field's value. +func (s *DescribeMapRunOutput) SetStopDate(v time.Time) *DescribeMapRunOutput { + s.StopDate = &v + return s +} + +// SetToleratedFailureCount sets the ToleratedFailureCount field's value. +func (s *DescribeMapRunOutput) SetToleratedFailureCount(v int64) *DescribeMapRunOutput { + s.ToleratedFailureCount = &v + return s +} + +// SetToleratedFailurePercentage sets the ToleratedFailurePercentage field's value. +func (s *DescribeMapRunOutput) SetToleratedFailurePercentage(v float64) *DescribeMapRunOutput { + s.ToleratedFailurePercentage = &v + return s +} + type DescribeStateMachineForExecutionInput struct { _ struct{} `type:"structure"` @@ -3951,9 +4555,19 @@ type DescribeStateMachineForExecutionOutput struct { // Definition is a required field Definition *string `locationName:"definition" min:"1" type:"string" required:"true" sensitive:"true"` + // A user-defined or an auto-generated string that identifies a Map state. This + // field is returned only if the executionArn is a child workflow execution + // that was started by a Distributed Map state. + Label *string `locationName:"label" type:"string"` + // The LoggingConfiguration data type is used to set CloudWatch Logs options. LoggingConfiguration *LoggingConfiguration `locationName:"loggingConfiguration" type:"structure"` + // The Amazon Resource Name (ARN) of the Map Run that started the child workflow + // execution. This field is returned only if the executionArn is a child workflow + // execution that was started by a Distributed Map state. + MapRunArn *string `locationName:"mapRunArn" min:"1" type:"string"` + // The name of the state machine associated with the execution. // // Name is a required field @@ -4004,12 +4618,24 @@ func (s *DescribeStateMachineForExecutionOutput) SetDefinition(v string) *Descri return s } +// SetLabel sets the Label field's value. +func (s *DescribeStateMachineForExecutionOutput) SetLabel(v string) *DescribeStateMachineForExecutionOutput { + s.Label = &v + return s +} + // SetLoggingConfiguration sets the LoggingConfiguration field's value. func (s *DescribeStateMachineForExecutionOutput) SetLoggingConfiguration(v *LoggingConfiguration) *DescribeStateMachineForExecutionOutput { s.LoggingConfiguration = v return s } +// SetMapRunArn sets the MapRunArn field's value. +func (s *DescribeStateMachineForExecutionOutput) SetMapRunArn(v string) *DescribeStateMachineForExecutionOutput { + s.MapRunArn = &v + return s +} + // SetName sets the Name field's value. func (s *DescribeStateMachineForExecutionOutput) SetName(v string) *DescribeStateMachineForExecutionOutput { s.Name = &v @@ -4107,6 +4733,11 @@ type DescribeStateMachineOutput struct { // Definition is a required field Definition *string `locationName:"definition" min:"1" type:"string" required:"true" sensitive:"true"` + // A user-defined or an auto-generated string that identifies a Map state. This + // parameter is present only if the stateMachineArn specified in input is a + // qualified state machine ARN. + Label *string `locationName:"label" type:"string"` + // The LoggingConfiguration data type is used to set CloudWatch Logs options. LoggingConfiguration *LoggingConfiguration `locationName:"loggingConfiguration" type:"structure"` @@ -4184,6 +4815,12 @@ func (s *DescribeStateMachineOutput) SetDefinition(v string) *DescribeStateMachi return s } +// SetLabel sets the Label field's value. +func (s *DescribeStateMachineOutput) SetLabel(v string) *DescribeStateMachineOutput { + s.Label = &v + return s +} + // SetLoggingConfiguration sets the LoggingConfiguration field's value. func (s *DescribeStateMachineOutput) SetLoggingConfiguration(v *LoggingConfiguration) *DescribeStateMachineOutput { s.LoggingConfiguration = v @@ -4528,6 +5165,17 @@ type ExecutionListItem struct { // ExecutionArn is a required field ExecutionArn *string `locationName:"executionArn" min:"1" type:"string" required:"true"` + // The total number of items processed in a child workflow execution. This field + // is returned only if mapRunArn was specified in the ListExecutions API action. + // If stateMachineArn was specified in ListExecutions, the itemCount field isn't + // returned. + ItemCount *int64 `locationName:"itemCount" type:"integer"` + + // The Amazon Resource Name (ARN) of a Map Run. This field is returned only + // if mapRunArn was specified in the ListExecutions API action. If stateMachineArn + // was specified in ListExecutions, the mapRunArn isn't returned. + MapRunArn *string `locationName:"mapRunArn" min:"1" type:"string"` + // The name of the execution. // // A name must not contain: @@ -4591,6 +5239,18 @@ func (s *ExecutionListItem) SetExecutionArn(v string) *ExecutionListItem { return s } +// SetItemCount sets the ItemCount field's value. +func (s *ExecutionListItem) SetItemCount(v int64) *ExecutionListItem { + s.ItemCount = &v + return s +} + +// SetMapRunArn sets the MapRunArn field's value. +func (s *ExecutionListItem) SetMapRunArn(v string) *ExecutionListItem { + s.MapRunArn = &v + return s +} + // SetName sets the Name field's value. func (s *ExecutionListItem) SetName(v string) *ExecutionListItem { s.Name = &v @@ -5103,6 +5763,14 @@ type HistoryEvent struct { // Contains details about an iteration of a Map state that succeeded. MapIterationSucceededEventDetails *MapIterationEventDetails `locationName:"mapIterationSucceededEventDetails" type:"structure"` + // Contains error and cause details about a Map Run that failed. + MapRunFailedEventDetails *MapRunFailedEventDetails `locationName:"mapRunFailedEventDetails" type:"structure"` + + // Contains details, such as mapRunArn, and the start date and time of a Map + // Run. mapRunArn is the Amazon Resource Name (ARN) of the Map Run that was + // started. + MapRunStartedEventDetails *MapRunStartedEventDetails `locationName:"mapRunStartedEventDetails" type:"structure"` + // Contains details about Map state that was started. MapStateStartedEventDetails *MapStateStartedEventDetails `locationName:"mapStateStartedEventDetails" type:"structure"` @@ -5300,6 +5968,18 @@ func (s *HistoryEvent) SetMapIterationSucceededEventDetails(v *MapIterationEvent return s } +// SetMapRunFailedEventDetails sets the MapRunFailedEventDetails field's value. +func (s *HistoryEvent) SetMapRunFailedEventDetails(v *MapRunFailedEventDetails) *HistoryEvent { + s.MapRunFailedEventDetails = v + return s +} + +// SetMapRunStartedEventDetails sets the MapRunStartedEventDetails field's value. +func (s *HistoryEvent) SetMapRunStartedEventDetails(v *MapRunStartedEventDetails) *HistoryEvent { + s.MapRunStartedEventDetails = v + return s +} + // SetMapStateStartedEventDetails sets the MapStateStartedEventDetails field's value. func (s *HistoryEvent) SetMapStateStartedEventDetails(v *MapStateStartedEventDetails) *HistoryEvent { s.MapStateStartedEventDetails = v @@ -5417,7 +6097,7 @@ func (s *HistoryEventExecutionDataDetails) SetTruncated(v bool) *HistoryEventExe return s } -// The provided Amazon Resource Name (ARN) is invalid. +// The provided Amazon Resource Name (ARN) is not valid. type InvalidArn struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -5481,7 +6161,7 @@ func (s *InvalidArn) RequestID() string { return s.RespMetadata.RequestID } -// The provided Amazon States Language definition is invalid. +// The provided Amazon States Language definition is not valid. type InvalidDefinition struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -5545,7 +6225,7 @@ func (s *InvalidDefinition) RequestID() string { return s.RespMetadata.RequestID } -// The provided JSON input data is invalid. +// The provided JSON input data is not valid. type InvalidExecutionInput struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -5672,7 +6352,7 @@ func (s *InvalidLoggingConfiguration) RequestID() string { return s.RespMetadata.RequestID } -// The provided name is invalid. +// The provided name is not valid. type InvalidName struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -5736,7 +6416,7 @@ func (s *InvalidName) RequestID() string { return s.RespMetadata.RequestID } -// The provided JSON output data is invalid. +// The provided JSON output data is not valid. type InvalidOutput struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -5800,7 +6480,7 @@ func (s *InvalidOutput) RequestID() string { return s.RespMetadata.RequestID } -// The provided token is invalid. +// The provided token is not valid. type InvalidToken struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -6360,6 +7040,15 @@ func (s *ListActivitiesOutput) SetNextToken(v string) *ListActivitiesOutput { type ListExecutionsInput struct { _ struct{} `type:"structure"` + // The Amazon Resource Name (ARN) of the Map Run that started the child workflow + // executions. If the mapRunArn field is specified, a list of all of the child + // workflow executions started by a Map Run is returned. For more information, + // see Examining Map Run (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-examine-map-run.html) + // in the Step Functions Developer Guide. + // + // You can specify either a mapRunArn or a stateMachineArn, but not both. + MapRunArn *string `locationName:"mapRunArn" min:"1" type:"string"` + // The maximum number of results that are returned per call. You can use nextToken // to obtain further pages of results. The default is 100 and the maximum allowed // page size is 1000. A value of 0 uses the default. @@ -6377,8 +7066,8 @@ type ListExecutionsInput struct { // The Amazon Resource Name (ARN) of the state machine whose executions is listed. // - // StateMachineArn is a required field - StateMachineArn *string `locationName:"stateMachineArn" min:"1" type:"string" required:"true"` + // You can specify either a mapRunArn or a stateMachineArn, but not both. + StateMachineArn *string `locationName:"stateMachineArn" min:"1" type:"string"` // If specified, only list the executions whose current execution status matches // the given filter. @@ -6406,12 +7095,12 @@ func (s ListExecutionsInput) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *ListExecutionsInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "ListExecutionsInput"} + if s.MapRunArn != nil && len(*s.MapRunArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("MapRunArn", 1)) + } if s.NextToken != nil && len(*s.NextToken) < 1 { invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) } - if s.StateMachineArn == nil { - invalidParams.Add(request.NewErrParamRequired("StateMachineArn")) - } if s.StateMachineArn != nil && len(*s.StateMachineArn) < 1 { invalidParams.Add(request.NewErrParamMinLen("StateMachineArn", 1)) } @@ -6422,6 +7111,12 @@ func (s *ListExecutionsInput) Validate() error { return nil } +// SetMapRunArn sets the MapRunArn field's value. +func (s *ListExecutionsInput) SetMapRunArn(v string) *ListExecutionsInput { + s.MapRunArn = &v + return s +} + // SetMaxResults sets the MaxResults field's value. func (s *ListExecutionsInput) SetMaxResults(v int64) *ListExecutionsInput { s.MaxResults = &v @@ -6492,9 +7187,15 @@ func (s *ListExecutionsOutput) SetNextToken(v string) *ListExecutionsOutput { return s } -type ListStateMachinesInput struct { +type ListMapRunsInput struct { _ struct{} `type:"structure"` + // The Amazon Resource Name (ARN) of the execution for which the Map Runs must + // be listed. + // + // ExecutionArn is a required field + ExecutionArn *string `locationName:"executionArn" min:"1" type:"string" required:"true"` + // The maximum number of results that are returned per call. You can use nextToken // to obtain further pages of results. The default is 100 and the maximum allowed // page size is 1000. A value of 0 uses the default. @@ -6516,7 +7217,7 @@ type ListStateMachinesInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListStateMachinesInput) String() string { +func (s ListMapRunsInput) String() string { return awsutil.Prettify(s) } @@ -6525,13 +7226,19 @@ func (s ListStateMachinesInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListStateMachinesInput) GoString() string { +func (s ListMapRunsInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ListStateMachinesInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ListStateMachinesInput"} +func (s *ListMapRunsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListMapRunsInput"} + if s.ExecutionArn == nil { + invalidParams.Add(request.NewErrParamRequired("ExecutionArn")) + } + if s.ExecutionArn != nil && len(*s.ExecutionArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ExecutionArn", 1)) + } if s.NextToken != nil && len(*s.NextToken) < 1 { invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) } @@ -6542,30 +7249,40 @@ func (s *ListStateMachinesInput) Validate() error { return nil } +// SetExecutionArn sets the ExecutionArn field's value. +func (s *ListMapRunsInput) SetExecutionArn(v string) *ListMapRunsInput { + s.ExecutionArn = &v + return s +} + // SetMaxResults sets the MaxResults field's value. -func (s *ListStateMachinesInput) SetMaxResults(v int64) *ListStateMachinesInput { +func (s *ListMapRunsInput) SetMaxResults(v int64) *ListMapRunsInput { s.MaxResults = &v return s } // SetNextToken sets the NextToken field's value. -func (s *ListStateMachinesInput) SetNextToken(v string) *ListStateMachinesInput { +func (s *ListMapRunsInput) SetNextToken(v string) *ListMapRunsInput { s.NextToken = &v return s } -type ListStateMachinesOutput struct { +type ListMapRunsOutput struct { _ struct{} `type:"structure"` + // An array that lists information related to a Map Run, such as the Amazon + // Resource Name (ARN) of the Map Run and the ARN of the state machine that + // started the Map Run. + // + // MapRuns is a required field + MapRuns []*MapRunListItem `locationName:"mapRuns" type:"list" required:"true"` + // If nextToken is returned, there are more results available. The value of // nextToken is a unique pagination token for each page. Make the call again // using the returned token to retrieve the next page. Keep all other arguments // unchanged. Each pagination token expires after 24 hours. Using an expired // pagination token will return an HTTP 400 InvalidToken error. NextToken *string `locationName:"nextToken" min:"1" type:"string"` - - // StateMachines is a required field - StateMachines []*StateMachineListItem `locationName:"stateMachines" type:"list" required:"true"` } // String returns the string representation. @@ -6573,7 +7290,7 @@ type ListStateMachinesOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListStateMachinesOutput) String() string { +func (s ListMapRunsOutput) String() string { return awsutil.Prettify(s) } @@ -6582,29 +7299,39 @@ func (s ListStateMachinesOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListStateMachinesOutput) GoString() string { +func (s ListMapRunsOutput) GoString() string { return s.String() } -// SetNextToken sets the NextToken field's value. -func (s *ListStateMachinesOutput) SetNextToken(v string) *ListStateMachinesOutput { - s.NextToken = &v +// SetMapRuns sets the MapRuns field's value. +func (s *ListMapRunsOutput) SetMapRuns(v []*MapRunListItem) *ListMapRunsOutput { + s.MapRuns = v return s } -// SetStateMachines sets the StateMachines field's value. -func (s *ListStateMachinesOutput) SetStateMachines(v []*StateMachineListItem) *ListStateMachinesOutput { - s.StateMachines = v +// SetNextToken sets the NextToken field's value. +func (s *ListMapRunsOutput) SetNextToken(v string) *ListMapRunsOutput { + s.NextToken = &v return s } -type ListTagsForResourceInput struct { +type ListStateMachinesInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) for the Step Functions state machine or activity. + // The maximum number of results that are returned per call. You can use nextToken + // to obtain further pages of results. The default is 100 and the maximum allowed + // page size is 1000. A value of 0 uses the default. // - // ResourceArn is a required field - ResourceArn *string `locationName:"resourceArn" min:"1" type:"string" required:"true"` + // This is only an upper limit. The actual number of results returned per call + // might be fewer than the specified maximum. + MaxResults *int64 `locationName:"maxResults" type:"integer"` + + // If nextToken is returned, there are more results available. The value of + // nextToken is a unique pagination token for each page. Make the call again + // using the returned token to retrieve the next page. Keep all other arguments + // unchanged. Each pagination token expires after 24 hours. Using an expired + // pagination token will return an HTTP 400 InvalidToken error. + NextToken *string `locationName:"nextToken" min:"1" type:"string"` } // String returns the string representation. @@ -6612,7 +7339,7 @@ type ListTagsForResourceInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListTagsForResourceInput) String() string { +func (s ListStateMachinesInput) String() string { return awsutil.Prettify(s) } @@ -6621,18 +7348,114 @@ func (s ListTagsForResourceInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListTagsForResourceInput) GoString() string { +func (s ListStateMachinesInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ListTagsForResourceInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ListTagsForResourceInput"} - if s.ResourceArn == nil { - invalidParams.Add(request.NewErrParamRequired("ResourceArn")) - } - if s.ResourceArn != nil && len(*s.ResourceArn) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1)) +func (s *ListStateMachinesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListStateMachinesInput"} + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListStateMachinesInput) SetMaxResults(v int64) *ListStateMachinesInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListStateMachinesInput) SetNextToken(v string) *ListStateMachinesInput { + s.NextToken = &v + return s +} + +type ListStateMachinesOutput struct { + _ struct{} `type:"structure"` + + // If nextToken is returned, there are more results available. The value of + // nextToken is a unique pagination token for each page. Make the call again + // using the returned token to retrieve the next page. Keep all other arguments + // unchanged. Each pagination token expires after 24 hours. Using an expired + // pagination token will return an HTTP 400 InvalidToken error. + NextToken *string `locationName:"nextToken" min:"1" type:"string"` + + // StateMachines is a required field + StateMachines []*StateMachineListItem `locationName:"stateMachines" type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListStateMachinesOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListStateMachinesOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListStateMachinesOutput) SetNextToken(v string) *ListStateMachinesOutput { + s.NextToken = &v + return s +} + +// SetStateMachines sets the StateMachines field's value. +func (s *ListStateMachinesOutput) SetStateMachines(v []*StateMachineListItem) *ListStateMachinesOutput { + s.StateMachines = v + return s +} + +type ListTagsForResourceInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) for the Step Functions state machine or activity. + // + // ResourceArn is a required field + ResourceArn *string `locationName:"resourceArn" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTagsForResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTagsForResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListTagsForResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListTagsForResourceInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ResourceArn != nil && len(*s.ResourceArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1)) } if invalidParams.Len() > 0 { @@ -6701,45 +7524,463 @@ func (s LogDestination) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s LogDestination) GoString() string { +func (s LogDestination) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *LogDestination) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "LogDestination"} + if s.CloudWatchLogsLogGroup != nil { + if err := s.CloudWatchLogsLogGroup.Validate(); err != nil { + invalidParams.AddNested("CloudWatchLogsLogGroup", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCloudWatchLogsLogGroup sets the CloudWatchLogsLogGroup field's value. +func (s *LogDestination) SetCloudWatchLogsLogGroup(v *CloudWatchLogsLogGroup) *LogDestination { + s.CloudWatchLogsLogGroup = v + return s +} + +// The LoggingConfiguration data type is used to set CloudWatch Logs options. +type LoggingConfiguration struct { + _ struct{} `type:"structure"` + + // An array of objects that describes where your execution history events will + // be logged. Limited to size 1. Required, if your log level is not set to OFF. + Destinations []*LogDestination `locationName:"destinations" type:"list"` + + // Determines whether execution data is included in your log. When set to false, + // data is excluded. + IncludeExecutionData *bool `locationName:"includeExecutionData" type:"boolean"` + + // Defines which category of execution history events are logged. + Level *string `locationName:"level" type:"string" enum:"LogLevel"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s LoggingConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s LoggingConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *LoggingConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "LoggingConfiguration"} + if s.Destinations != nil { + for i, v := range s.Destinations { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Destinations", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDestinations sets the Destinations field's value. +func (s *LoggingConfiguration) SetDestinations(v []*LogDestination) *LoggingConfiguration { + s.Destinations = v + return s +} + +// SetIncludeExecutionData sets the IncludeExecutionData field's value. +func (s *LoggingConfiguration) SetIncludeExecutionData(v bool) *LoggingConfiguration { + s.IncludeExecutionData = &v + return s +} + +// SetLevel sets the Level field's value. +func (s *LoggingConfiguration) SetLevel(v string) *LoggingConfiguration { + s.Level = &v + return s +} + +// Contains details about an iteration of a Map state. +type MapIterationEventDetails struct { + _ struct{} `type:"structure"` + + // The index of the array belonging to the Map state iteration. + Index *int64 `locationName:"index" type:"integer"` + + // The name of the iteration’s parent Map state. + Name *string `locationName:"name" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s MapIterationEventDetails) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s MapIterationEventDetails) GoString() string { + return s.String() +} + +// SetIndex sets the Index field's value. +func (s *MapIterationEventDetails) SetIndex(v int64) *MapIterationEventDetails { + s.Index = &v + return s +} + +// SetName sets the Name field's value. +func (s *MapIterationEventDetails) SetName(v string) *MapIterationEventDetails { + s.Name = &v + return s +} + +// Contains details about all of the child workflow executions started by a +// Map Run. +type MapRunExecutionCounts struct { + _ struct{} `type:"structure"` + + // The total number of child workflow executions that were started by a Map + // Run and were running, but were either stopped by the user or by Step Functions + // because the Map Run failed. + // + // Aborted is a required field + Aborted *int64 `locationName:"aborted" type:"long" required:"true"` + + // The total number of child workflow executions that were started by a Map + // Run, but have failed. + // + // Failed is a required field + Failed *int64 `locationName:"failed" type:"long" required:"true"` + + // The total number of child workflow executions that were started by a Map + // Run, but haven't started executing yet. + // + // Pending is a required field + Pending *int64 `locationName:"pending" type:"long" required:"true"` + + // Returns the count of child workflow executions whose results were written + // by ResultWriter. For more information, see ResultWriter (https://docs.aws.amazon.com/step-functions/latest/dg/input-output-resultwriter.html) + // in the Step Functions Developer Guide. + // + // ResultsWritten is a required field + ResultsWritten *int64 `locationName:"resultsWritten" type:"long" required:"true"` + + // The total number of child workflow executions that were started by a Map + // Run and are currently in-progress. + // + // Running is a required field + Running *int64 `locationName:"running" type:"long" required:"true"` + + // The total number of child workflow executions that were started by a Map + // Run and have completed successfully. + // + // Succeeded is a required field + Succeeded *int64 `locationName:"succeeded" type:"long" required:"true"` + + // The total number of child workflow executions that were started by a Map + // Run and have timed out. + // + // TimedOut is a required field + TimedOut *int64 `locationName:"timedOut" type:"long" required:"true"` + + // The total number of child workflow executions that were started by a Map + // Run. + // + // Total is a required field + Total *int64 `locationName:"total" type:"long" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s MapRunExecutionCounts) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s MapRunExecutionCounts) GoString() string { + return s.String() +} + +// SetAborted sets the Aborted field's value. +func (s *MapRunExecutionCounts) SetAborted(v int64) *MapRunExecutionCounts { + s.Aborted = &v + return s +} + +// SetFailed sets the Failed field's value. +func (s *MapRunExecutionCounts) SetFailed(v int64) *MapRunExecutionCounts { + s.Failed = &v + return s +} + +// SetPending sets the Pending field's value. +func (s *MapRunExecutionCounts) SetPending(v int64) *MapRunExecutionCounts { + s.Pending = &v + return s +} + +// SetResultsWritten sets the ResultsWritten field's value. +func (s *MapRunExecutionCounts) SetResultsWritten(v int64) *MapRunExecutionCounts { + s.ResultsWritten = &v + return s +} + +// SetRunning sets the Running field's value. +func (s *MapRunExecutionCounts) SetRunning(v int64) *MapRunExecutionCounts { + s.Running = &v + return s +} + +// SetSucceeded sets the Succeeded field's value. +func (s *MapRunExecutionCounts) SetSucceeded(v int64) *MapRunExecutionCounts { + s.Succeeded = &v + return s +} + +// SetTimedOut sets the TimedOut field's value. +func (s *MapRunExecutionCounts) SetTimedOut(v int64) *MapRunExecutionCounts { + s.TimedOut = &v + return s +} + +// SetTotal sets the Total field's value. +func (s *MapRunExecutionCounts) SetTotal(v int64) *MapRunExecutionCounts { + s.Total = &v + return s +} + +// Contains details about a Map Run failure event that occurred during a state +// machine execution. +type MapRunFailedEventDetails struct { + _ struct{} `type:"structure"` + + // A more detailed explanation of the cause of the failure. + // + // Cause is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by MapRunFailedEventDetails's + // String and GoString methods. + Cause *string `locationName:"cause" type:"string" sensitive:"true"` + + // The error code of the Map Run failure. + // + // Error is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by MapRunFailedEventDetails's + // String and GoString methods. + Error *string `locationName:"error" type:"string" sensitive:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s MapRunFailedEventDetails) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s MapRunFailedEventDetails) GoString() string { + return s.String() +} + +// SetCause sets the Cause field's value. +func (s *MapRunFailedEventDetails) SetCause(v string) *MapRunFailedEventDetails { + s.Cause = &v + return s +} + +// SetError sets the Error field's value. +func (s *MapRunFailedEventDetails) SetError(v string) *MapRunFailedEventDetails { + s.Error = &v + return s +} + +// Contains details about items that were processed in all of the child workflow +// executions that were started by a Map Run. +type MapRunItemCounts struct { + _ struct{} `type:"structure"` + + // The total number of items processed in child workflow executions that were + // either stopped by the user or by Step Functions, because the Map Run failed. + // + // Aborted is a required field + Aborted *int64 `locationName:"aborted" type:"long" required:"true"` + + // The total number of items processed in child workflow executions that have + // failed. + // + // Failed is a required field + Failed *int64 `locationName:"failed" type:"long" required:"true"` + + // The total number of items to process in child workflow executions that haven't + // started running yet. + // + // Pending is a required field + Pending *int64 `locationName:"pending" type:"long" required:"true"` + + // Returns the count of items whose results were written by ResultWriter. For + // more information, see ResultWriter (https://docs.aws.amazon.com/step-functions/latest/dg/input-output-resultwriter.html) + // in the Step Functions Developer Guide. + // + // ResultsWritten is a required field + ResultsWritten *int64 `locationName:"resultsWritten" type:"long" required:"true"` + + // The total number of items being processed in child workflow executions that + // are currently in-progress. + // + // Running is a required field + Running *int64 `locationName:"running" type:"long" required:"true"` + + // The total number of items processed in child workflow executions that have + // completed successfully. + // + // Succeeded is a required field + Succeeded *int64 `locationName:"succeeded" type:"long" required:"true"` + + // The total number of items processed in child workflow executions that have + // timed out. + // + // TimedOut is a required field + TimedOut *int64 `locationName:"timedOut" type:"long" required:"true"` + + // The total number of items processed in all the child workflow executions + // started by a Map Run. + // + // Total is a required field + Total *int64 `locationName:"total" type:"long" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s MapRunItemCounts) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s MapRunItemCounts) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *LogDestination) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "LogDestination"} - if s.CloudWatchLogsLogGroup != nil { - if err := s.CloudWatchLogsLogGroup.Validate(); err != nil { - invalidParams.AddNested("CloudWatchLogsLogGroup", err.(request.ErrInvalidParams)) - } - } +// SetAborted sets the Aborted field's value. +func (s *MapRunItemCounts) SetAborted(v int64) *MapRunItemCounts { + s.Aborted = &v + return s +} - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetFailed sets the Failed field's value. +func (s *MapRunItemCounts) SetFailed(v int64) *MapRunItemCounts { + s.Failed = &v + return s } -// SetCloudWatchLogsLogGroup sets the CloudWatchLogsLogGroup field's value. -func (s *LogDestination) SetCloudWatchLogsLogGroup(v *CloudWatchLogsLogGroup) *LogDestination { - s.CloudWatchLogsLogGroup = v +// SetPending sets the Pending field's value. +func (s *MapRunItemCounts) SetPending(v int64) *MapRunItemCounts { + s.Pending = &v return s } -// The LoggingConfiguration data type is used to set CloudWatch Logs options. -type LoggingConfiguration struct { +// SetResultsWritten sets the ResultsWritten field's value. +func (s *MapRunItemCounts) SetResultsWritten(v int64) *MapRunItemCounts { + s.ResultsWritten = &v + return s +} + +// SetRunning sets the Running field's value. +func (s *MapRunItemCounts) SetRunning(v int64) *MapRunItemCounts { + s.Running = &v + return s +} + +// SetSucceeded sets the Succeeded field's value. +func (s *MapRunItemCounts) SetSucceeded(v int64) *MapRunItemCounts { + s.Succeeded = &v + return s +} + +// SetTimedOut sets the TimedOut field's value. +func (s *MapRunItemCounts) SetTimedOut(v int64) *MapRunItemCounts { + s.TimedOut = &v + return s +} + +// SetTotal sets the Total field's value. +func (s *MapRunItemCounts) SetTotal(v int64) *MapRunItemCounts { + s.Total = &v + return s +} + +// Contains details about a specific Map Run. +type MapRunListItem struct { _ struct{} `type:"structure"` - // An array of objects that describes where your execution history events will - // be logged. Limited to size 1. Required, if your log level is not set to OFF. - Destinations []*LogDestination `locationName:"destinations" type:"list"` + // The executionArn of the execution from which the Map Run was started. + // + // ExecutionArn is a required field + ExecutionArn *string `locationName:"executionArn" min:"1" type:"string" required:"true"` - // Determines whether execution data is included in your log. When set to false, - // data is excluded. - IncludeExecutionData *bool `locationName:"includeExecutionData" type:"boolean"` + // The Amazon Resource Name (ARN) of the Map Run. + // + // MapRunArn is a required field + MapRunArn *string `locationName:"mapRunArn" min:"1" type:"string" required:"true"` - // Defines which category of execution history events are logged. - Level *string `locationName:"level" type:"string" enum:"LogLevel"` + // The date on which the Map Run started. + // + // StartDate is a required field + StartDate *time.Time `locationName:"startDate" type:"timestamp" required:"true"` + + // The Amazon Resource Name (ARN) of the executed state machine. + // + // StateMachineArn is a required field + StateMachineArn *string `locationName:"stateMachineArn" min:"1" type:"string" required:"true"` + + // The date on which the Map Run stopped. + StopDate *time.Time `locationName:"stopDate" type:"timestamp"` } // String returns the string representation. @@ -6747,7 +7988,7 @@ type LoggingConfiguration struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s LoggingConfiguration) String() string { +func (s MapRunListItem) String() string { return awsutil.Prettify(s) } @@ -6756,57 +7997,47 @@ func (s LoggingConfiguration) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s LoggingConfiguration) GoString() string { +func (s MapRunListItem) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *LoggingConfiguration) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "LoggingConfiguration"} - if s.Destinations != nil { - for i, v := range s.Destinations { - if v == nil { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Destinations", i), err.(request.ErrInvalidParams)) - } - } - } +// SetExecutionArn sets the ExecutionArn field's value. +func (s *MapRunListItem) SetExecutionArn(v string) *MapRunListItem { + s.ExecutionArn = &v + return s +} - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetMapRunArn sets the MapRunArn field's value. +func (s *MapRunListItem) SetMapRunArn(v string) *MapRunListItem { + s.MapRunArn = &v + return s } -// SetDestinations sets the Destinations field's value. -func (s *LoggingConfiguration) SetDestinations(v []*LogDestination) *LoggingConfiguration { - s.Destinations = v +// SetStartDate sets the StartDate field's value. +func (s *MapRunListItem) SetStartDate(v time.Time) *MapRunListItem { + s.StartDate = &v return s } -// SetIncludeExecutionData sets the IncludeExecutionData field's value. -func (s *LoggingConfiguration) SetIncludeExecutionData(v bool) *LoggingConfiguration { - s.IncludeExecutionData = &v +// SetStateMachineArn sets the StateMachineArn field's value. +func (s *MapRunListItem) SetStateMachineArn(v string) *MapRunListItem { + s.StateMachineArn = &v return s } -// SetLevel sets the Level field's value. -func (s *LoggingConfiguration) SetLevel(v string) *LoggingConfiguration { - s.Level = &v +// SetStopDate sets the StopDate field's value. +func (s *MapRunListItem) SetStopDate(v time.Time) *MapRunListItem { + s.StopDate = &v return s } -// Contains details about an iteration of a Map state. -type MapIterationEventDetails struct { +// Contains details about a Map Run that was started during a state machine +// execution. +type MapRunStartedEventDetails struct { _ struct{} `type:"structure"` - // The index of the array belonging to the Map state iteration. - Index *int64 `locationName:"index" type:"integer"` - - // The name of the iteration’s parent Map state. - Name *string `locationName:"name" min:"1" type:"string"` + // The Amazon Resource Name (ARN) of a Map Run that was started. + MapRunArn *string `locationName:"mapRunArn" min:"1" type:"string"` } // String returns the string representation. @@ -6814,7 +8045,7 @@ type MapIterationEventDetails struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s MapIterationEventDetails) String() string { +func (s MapRunStartedEventDetails) String() string { return awsutil.Prettify(s) } @@ -6823,19 +8054,13 @@ func (s MapIterationEventDetails) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s MapIterationEventDetails) GoString() string { +func (s MapRunStartedEventDetails) GoString() string { return s.String() } -// SetIndex sets the Index field's value. -func (s *MapIterationEventDetails) SetIndex(v int64) *MapIterationEventDetails { - s.Index = &v - return s -} - -// SetName sets the Name field's value. -func (s *MapIterationEventDetails) SetName(v string) *MapIterationEventDetails { - s.Name = &v +// SetMapRunArn sets the MapRunArn field's value. +func (s *MapRunStartedEventDetails) SetMapRunArn(v string) *MapRunStartedEventDetails { + s.MapRunArn = &v return s } @@ -9400,6 +10625,105 @@ func (s UntagResourceOutput) GoString() string { return s.String() } +type UpdateMapRunInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of a Map Run. + // + // MapRunArn is a required field + MapRunArn *string `locationName:"mapRunArn" min:"1" type:"string" required:"true"` + + // The maximum number of child workflow executions that can be specified to + // run in parallel for the Map Run at the same time. + MaxConcurrency *int64 `locationName:"maxConcurrency" type:"integer"` + + // The maximum number of failed items before the Map Run fails. + ToleratedFailureCount *int64 `locationName:"toleratedFailureCount" type:"long"` + + // The maximum percentage of failed items before the Map Run fails. + ToleratedFailurePercentage *float64 `locationName:"toleratedFailurePercentage" type:"float"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateMapRunInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateMapRunInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateMapRunInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateMapRunInput"} + if s.MapRunArn == nil { + invalidParams.Add(request.NewErrParamRequired("MapRunArn")) + } + if s.MapRunArn != nil && len(*s.MapRunArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("MapRunArn", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMapRunArn sets the MapRunArn field's value. +func (s *UpdateMapRunInput) SetMapRunArn(v string) *UpdateMapRunInput { + s.MapRunArn = &v + return s +} + +// SetMaxConcurrency sets the MaxConcurrency field's value. +func (s *UpdateMapRunInput) SetMaxConcurrency(v int64) *UpdateMapRunInput { + s.MaxConcurrency = &v + return s +} + +// SetToleratedFailureCount sets the ToleratedFailureCount field's value. +func (s *UpdateMapRunInput) SetToleratedFailureCount(v int64) *UpdateMapRunInput { + s.ToleratedFailureCount = &v + return s +} + +// SetToleratedFailurePercentage sets the ToleratedFailurePercentage field's value. +func (s *UpdateMapRunInput) SetToleratedFailurePercentage(v float64) *UpdateMapRunInput { + s.ToleratedFailurePercentage = &v + return s +} + +type UpdateMapRunOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateMapRunOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateMapRunOutput) GoString() string { + return s.String() +} + type UpdateStateMachineInput struct { _ struct{} `type:"structure"` @@ -9534,6 +10858,75 @@ func (s *UpdateStateMachineOutput) SetUpdateDate(v time.Time) *UpdateStateMachin return s } +// The input does not satisfy the constraints specified by an Amazon Web Services +// service. +type ValidationException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" type:"string"` + + // The input does not satisfy the constraints specified by an Amazon Web Services + // service. + Reason *string `locationName:"reason" type:"string" enum:"ValidationExceptionReason"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ValidationException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ValidationException) GoString() string { + return s.String() +} + +func newErrorValidationException(v protocol.ResponseMetadata) error { + return &ValidationException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ValidationException) Code() string { + return "ValidationException" +} + +// Message returns the exception's message. +func (s *ValidationException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ValidationException) OrigErr() error { + return nil +} + +func (s *ValidationException) Error() string { + return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ValidationException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ValidationException) RequestID() string { + return s.RespMetadata.RequestID +} + const ( // ExecutionStatusRunning is a ExecutionStatus enum value ExecutionStatusRunning = "RUNNING" @@ -9727,6 +11120,18 @@ const ( // HistoryEventTypeWaitStateExited is a HistoryEventType enum value HistoryEventTypeWaitStateExited = "WaitStateExited" + + // HistoryEventTypeMapRunAborted is a HistoryEventType enum value + HistoryEventTypeMapRunAborted = "MapRunAborted" + + // HistoryEventTypeMapRunFailed is a HistoryEventType enum value + HistoryEventTypeMapRunFailed = "MapRunFailed" + + // HistoryEventTypeMapRunStarted is a HistoryEventType enum value + HistoryEventTypeMapRunStarted = "MapRunStarted" + + // HistoryEventTypeMapRunSucceeded is a HistoryEventType enum value + HistoryEventTypeMapRunSucceeded = "MapRunSucceeded" ) // HistoryEventType_Values returns all elements of the HistoryEventType enum @@ -9787,6 +11192,10 @@ func HistoryEventType_Values() []string { HistoryEventTypeWaitStateAborted, HistoryEventTypeWaitStateEntered, HistoryEventTypeWaitStateExited, + HistoryEventTypeMapRunAborted, + HistoryEventTypeMapRunFailed, + HistoryEventTypeMapRunStarted, + HistoryEventTypeMapRunSucceeded, } } @@ -9814,6 +11223,30 @@ func LogLevel_Values() []string { } } +const ( + // MapRunStatusRunning is a MapRunStatus enum value + MapRunStatusRunning = "RUNNING" + + // MapRunStatusSucceeded is a MapRunStatus enum value + MapRunStatusSucceeded = "SUCCEEDED" + + // MapRunStatusFailed is a MapRunStatus enum value + MapRunStatusFailed = "FAILED" + + // MapRunStatusAborted is a MapRunStatus enum value + MapRunStatusAborted = "ABORTED" +) + +// MapRunStatus_Values returns all elements of the MapRunStatus enum +func MapRunStatus_Values() []string { + return []string{ + MapRunStatusRunning, + MapRunStatusSucceeded, + MapRunStatusFailed, + MapRunStatusAborted, + } +} + const ( // StateMachineStatusActive is a StateMachineStatus enum value StateMachineStatusActive = "ACTIVE" @@ -9865,3 +11298,23 @@ func SyncExecutionStatus_Values() []string { SyncExecutionStatusTimedOut, } } + +const ( + // ValidationExceptionReasonApiDoesNotSupportLabeledArns is a ValidationExceptionReason enum value + ValidationExceptionReasonApiDoesNotSupportLabeledArns = "API_DOES_NOT_SUPPORT_LABELED_ARNS" + + // ValidationExceptionReasonMissingRequiredParameter is a ValidationExceptionReason enum value + ValidationExceptionReasonMissingRequiredParameter = "MISSING_REQUIRED_PARAMETER" + + // ValidationExceptionReasonCannotUpdateCompletedMapRun is a ValidationExceptionReason enum value + ValidationExceptionReasonCannotUpdateCompletedMapRun = "CANNOT_UPDATE_COMPLETED_MAP_RUN" +) + +// ValidationExceptionReason_Values returns all elements of the ValidationExceptionReason enum +func ValidationExceptionReason_Values() []string { + return []string{ + ValidationExceptionReasonApiDoesNotSupportLabeledArns, + ValidationExceptionReasonMissingRequiredParameter, + ValidationExceptionReasonCannotUpdateCompletedMapRun, + } +} diff --git a/service/sfn/errors.go b/service/sfn/errors.go index 2e990c787aa..342557d3da5 100644 --- a/service/sfn/errors.go +++ b/service/sfn/errors.go @@ -52,19 +52,19 @@ const ( // ErrCodeInvalidArn for service response error code // "InvalidArn". // - // The provided Amazon Resource Name (ARN) is invalid. + // The provided Amazon Resource Name (ARN) is not valid. ErrCodeInvalidArn = "InvalidArn" // ErrCodeInvalidDefinition for service response error code // "InvalidDefinition". // - // The provided Amazon States Language definition is invalid. + // The provided Amazon States Language definition is not valid. ErrCodeInvalidDefinition = "InvalidDefinition" // ErrCodeInvalidExecutionInput for service response error code // "InvalidExecutionInput". // - // The provided JSON input data is invalid. + // The provided JSON input data is not valid. ErrCodeInvalidExecutionInput = "InvalidExecutionInput" // ErrCodeInvalidLoggingConfiguration for service response error code @@ -74,19 +74,19 @@ const ( // ErrCodeInvalidName for service response error code // "InvalidName". // - // The provided name is invalid. + // The provided name is not valid. ErrCodeInvalidName = "InvalidName" // ErrCodeInvalidOutput for service response error code // "InvalidOutput". // - // The provided JSON output data is invalid. + // The provided JSON output data is not valid. ErrCodeInvalidOutput = "InvalidOutput" // ErrCodeInvalidToken for service response error code // "InvalidToken". // - // The provided token is invalid. + // The provided token is not valid. ErrCodeInvalidToken = "InvalidToken" // ErrCodeInvalidTracingConfiguration for service response error code @@ -155,6 +155,13 @@ const ( // Topic (https://docs.aws.amazon.com/step-functions/latest/dg/limits.html) // in the Step Functions Developer Guide. ErrCodeTooManyTags = "TooManyTags" + + // ErrCodeValidationException for service response error code + // "ValidationException". + // + // The input does not satisfy the constraints specified by an Amazon Web Services + // service. + ErrCodeValidationException = "ValidationException" ) var exceptionFromCode = map[string]func(protocol.ResponseMetadata) error{ @@ -182,4 +189,5 @@ var exceptionFromCode = map[string]func(protocol.ResponseMetadata) error{ "TaskDoesNotExist": newErrorTaskDoesNotExist, "TaskTimedOut": newErrorTaskTimedOut, "TooManyTags": newErrorTooManyTags, + "ValidationException": newErrorValidationException, } diff --git a/service/sfn/sfniface/interface.go b/service/sfn/sfniface/interface.go index 264ad746aea..652c92e003c 100644 --- a/service/sfn/sfniface/interface.go +++ b/service/sfn/sfniface/interface.go @@ -84,6 +84,10 @@ type SFNAPI interface { DescribeExecutionWithContext(aws.Context, *sfn.DescribeExecutionInput, ...request.Option) (*sfn.DescribeExecutionOutput, error) DescribeExecutionRequest(*sfn.DescribeExecutionInput) (*request.Request, *sfn.DescribeExecutionOutput) + DescribeMapRun(*sfn.DescribeMapRunInput) (*sfn.DescribeMapRunOutput, error) + DescribeMapRunWithContext(aws.Context, *sfn.DescribeMapRunInput, ...request.Option) (*sfn.DescribeMapRunOutput, error) + DescribeMapRunRequest(*sfn.DescribeMapRunInput) (*request.Request, *sfn.DescribeMapRunOutput) + DescribeStateMachine(*sfn.DescribeStateMachineInput) (*sfn.DescribeStateMachineOutput, error) DescribeStateMachineWithContext(aws.Context, *sfn.DescribeStateMachineInput, ...request.Option) (*sfn.DescribeStateMachineOutput, error) DescribeStateMachineRequest(*sfn.DescribeStateMachineInput) (*request.Request, *sfn.DescribeStateMachineOutput) @@ -117,6 +121,13 @@ type SFNAPI interface { ListExecutionsPages(*sfn.ListExecutionsInput, func(*sfn.ListExecutionsOutput, bool) bool) error ListExecutionsPagesWithContext(aws.Context, *sfn.ListExecutionsInput, func(*sfn.ListExecutionsOutput, bool) bool, ...request.Option) error + ListMapRuns(*sfn.ListMapRunsInput) (*sfn.ListMapRunsOutput, error) + ListMapRunsWithContext(aws.Context, *sfn.ListMapRunsInput, ...request.Option) (*sfn.ListMapRunsOutput, error) + ListMapRunsRequest(*sfn.ListMapRunsInput) (*request.Request, *sfn.ListMapRunsOutput) + + ListMapRunsPages(*sfn.ListMapRunsInput, func(*sfn.ListMapRunsOutput, bool) bool) error + ListMapRunsPagesWithContext(aws.Context, *sfn.ListMapRunsInput, func(*sfn.ListMapRunsOutput, bool) bool, ...request.Option) error + ListStateMachines(*sfn.ListStateMachinesInput) (*sfn.ListStateMachinesOutput, error) ListStateMachinesWithContext(aws.Context, *sfn.ListStateMachinesInput, ...request.Option) (*sfn.ListStateMachinesOutput, error) ListStateMachinesRequest(*sfn.ListStateMachinesInput) (*request.Request, *sfn.ListStateMachinesOutput) @@ -160,6 +171,10 @@ type SFNAPI interface { UntagResourceWithContext(aws.Context, *sfn.UntagResourceInput, ...request.Option) (*sfn.UntagResourceOutput, error) UntagResourceRequest(*sfn.UntagResourceInput) (*request.Request, *sfn.UntagResourceOutput) + UpdateMapRun(*sfn.UpdateMapRunInput) (*sfn.UpdateMapRunOutput, error) + UpdateMapRunWithContext(aws.Context, *sfn.UpdateMapRunInput, ...request.Option) (*sfn.UpdateMapRunOutput, error) + UpdateMapRunRequest(*sfn.UpdateMapRunInput) (*request.Request, *sfn.UpdateMapRunOutput) + UpdateStateMachine(*sfn.UpdateStateMachineInput) (*sfn.UpdateStateMachineOutput, error) UpdateStateMachineWithContext(aws.Context, *sfn.UpdateStateMachineInput, ...request.Option) (*sfn.UpdateStateMachineOutput, error) UpdateStateMachineRequest(*sfn.UpdateStateMachineInput) (*request.Request, *sfn.UpdateStateMachineOutput)