Amazon Comprehend is an AWS service for gaining insight into the content of documents. Use these actions to determine the topics contained in your documents, the topics they discuss, the predominant sentiment expressed in them, the predominant language used, and more.
", "operations": { "BatchDetectDominantLanguage": "Determines the dominant language of the input text for a batch of documents. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.
", - "BatchDetectEntities": "Inspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see how-entities
", + "BatchDetectEntities": "Inspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see Entities in the Comprehend Developer Guide.
", "BatchDetectKeyPhrases": "Detects the key noun phrases found in a batch of documents.
", "BatchDetectSentiment": "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 how-syntax.
", + "BatchDetectSyntax": "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.
", "ContainsPiiEntities": "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 how-document-classification.
", + "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.
", "CreateEntityRecognizer": "Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is submitted, you can check job status using the API.
Deletes a previously created document classifier
Only those classifiers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a ResourceInUseException will be returned.
This is an asynchronous action that puts the classifier into a DELETING state, and it is then removed by a background job. Once removed, the classifier disappears from your account and is no longer available for use.
", @@ -30,11 +31,12 @@ "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 how-entities.
", + "DetectEntities": "Inspects text for named entities, and returns information about them. For more information, about named entities, see Entities in the Comprehend Developer Guide.
", "DetectKeyPhrases": "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).
Inspects text for syntax and the part of speech of words in the document. For more information, how-syntax.
", + "DetectSyntax": "Inspects text for syntax and the part of speech of words in the document. For more information, see Syntax in the Comprehend Developer Guide.
", + "DetectTargetedSentiment": "Inspects the input text and returns a sentiment analysis for each entity identified in the text.
For more information about targeted sentiment, see Targeted sentiment.
", "ImportModel": "Creates a new custom model that replicates a source custom model that you import. The source model can be in your AWS account or another one.
If the source model is in another AWS account, then it must have a resource-based policy that authorizes you to import it.
The source model must be in the same AWS region that you're using when you import. You can't import a model that's in a different region.
", "ListDocumentClassificationJobs": "Gets a list of the documentation classification jobs that you have submitted.
", "ListDocumentClassifierSummaries": "Gets a list of summaries of the document classifiers that you have created
", @@ -198,6 +200,22 @@ "refs": { } }, + "BatchDetectTargetedSentimentItemResult": { + "base": "Analysis results for one of the documents in the batch.
", + "refs": { + "ListOfDetectTargetedSentimentResult$member": null + } + }, + "BatchDetectTargetedSentimentRequest": { + "base": null, + "refs": { + } + }, + "BatchDetectTargetedSentimentResponse": { + "base": null, + "refs": { + } + }, "BatchItemError": { "base": "Describes an error that occurred while processing a document in a batch. The operation returns on BatchItemError object for each document that contained an error.
A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.
A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.
A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.
A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.
A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.
List of errors that the operation can return.
" } }, "BatchSizeLimitExceededException": { @@ -378,21 +397,23 @@ "refs": { "ClassifyDocumentRequest$Text": "The document text to be analyzed.
", "CustomerInputStringList$member": null, - "DetectDominantLanguageRequest$Text": "A UTF-8 text string. Each string should contain at least 20 characters and must contain fewer that 5,000 bytes of UTF-8 encoded characters.
", - "DetectEntitiesRequest$Text": "A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.
", - "DetectKeyPhrasesRequest$Text": "A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.
", - "DetectSentimentRequest$Text": "A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.
", - "DetectSyntaxRequest$Text": "A UTF-8 string. Each string must contain fewer that 5,000 bytes of UTF encoded characters.
" + "DetectDominantLanguageRequest$Text": "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.
", + "DetectKeyPhrasesRequest$Text": "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.
", + "DetectTargetedSentimentRequest$Text": "A UTF-8 text string. The maximum string length is 5 KB.
" } }, "CustomerInputStringList": { "base": null, "refs": { - "BatchDetectDominantLanguageRequest$TextList": "A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document should contain at least 20 characters and must contain fewer than 5,000 bytes of UTF-8 encoded characters.
", - "BatchDetectEntitiesRequest$TextList": "A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer than 5,000 bytes of UTF-8 encoded characters.
", - "BatchDetectKeyPhrasesRequest$TextList": "A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer than 5,000 bytes of UTF-8 encoded characters.
", - "BatchDetectSentimentRequest$TextList": "A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.
", - "BatchDetectSyntaxRequest$TextList": "A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.
" + "BatchDetectDominantLanguageRequest$TextList": "A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. Each document should contain at least 20 characters. The maximum size of each document is 5 KB.
", + "BatchDetectEntitiesRequest$TextList": "A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.
", + "BatchDetectKeyPhrasesRequest$TextList": "A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.
", + "BatchDetectSentimentRequest$TextList": "A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document 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 list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size for each document is 5 KB.
", + "BatchDetectTargetedSentimentRequest$TextList": "A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.
" } }, "DeleteDocumentClassifierRequest": { @@ -625,6 +646,16 @@ "refs": { } }, + "DetectTargetedSentimentRequest": { + "base": null, + "refs": { + } + }, + "DetectTargetedSentimentResponse": { + "base": null, + "refs": { + } + }, "DocumentClass": { "base": "Specifies the class that categorizes the document being analyzed
", "refs": { @@ -688,7 +719,7 @@ } }, "DocumentClassifierInputDataConfig": { - "base": "The input properties for training a document classifier.
For more information on how the input file is formatted, see prep-classifier-data.
", + "base": "The input properties for training a document classifier.
For more information on how the input file is formatted, see Preparing training data in the Comprehend Developer Guide.
", "refs": { "CreateDocumentClassifierRequest$InputDataConfig": "Specifies the format and location of the input data for the job.
", "DocumentClassifierProperties$InputDataConfig": "The input data configuration that you supplied when you created the document classifier for training.
" @@ -1044,7 +1075,9 @@ "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 level of confidence that Amazon Comprehend has in the accuracy of its detection of the MIXED sentiment.
The level of confidence that Amazon Comprehend has in the accuracy of its detection of the MIXED sentiment.
Model confidence that the entity is relevant. Value range is zero to one, where one is highest confidence.
", + "TargetedSentimentMention$GroupScore": "The confidence that all the entities mentioned in the group relate to the same entity.
" } }, "IamRoleArn": { @@ -1136,24 +1169,28 @@ "BatchDetectKeyPhrasesItemResult$Index": "The zero-based index of the document in the input list.
", "BatchDetectSentimentItemResult$Index": "The zero-based index of the document in the input list.
", "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.
", "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.
", "DocumentClassifierSummary$NumberOfVersions": "The number of versions you created.
", - "Entity$BeginOffset": "A character offset in the input text that shows where the entity begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.
", - "Entity$EndOffset": "A character offset in the input text that shows where the entity ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.
", + "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.
", "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.
", - "KeyPhrase$BeginOffset": "A character offset in the input text that shows where the key phrase begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.
", - "KeyPhrase$EndOffset": "A character offset in the input text where the key phrase ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.
A character offset in the input text that shows where the PII entity begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.
", - "PiiEntity$EndOffset": "A character offset in the input text that shows where the PII entity ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.
", + "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, + "PiiEntity$BeginOffset": "The zero-based offset from the beginning of the source text to the first character in the entity.
", + "PiiEntity$EndOffset": "The zero-based offset from the beginning of the source text to the last character in the entity.
", "SyntaxToken$TokenId": "A unique identifier for a token.
", "SyntaxToken$BeginOffset": "The zero-based offset from the beginning of the source text to the first character in the word.
", "SyntaxToken$EndOffset": "The zero-based offset from the beginning of the source text to the last character in the word.
", + "TargetedSentimentMention$BeginOffset": "The offset into the document text where the mention begins.
", + "TargetedSentimentMention$EndOffset": "The offset into the document text where the mention ends.
", "TopicsDetectionJobProperties$NumberOfTopics": "The number of topics to detect supplied when you created the topic detection job. The default is 10.
" } }, @@ -1367,6 +1404,7 @@ "BatchDetectEntitiesRequest$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.
", "BatchDetectKeyPhrasesRequest$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.
", "BatchDetectSentimentRequest$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.
", + "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.
", @@ -1374,6 +1412,7 @@ "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.
", + "DetectTargetedSentimentRequest$LanguageCode": "The language of the input documents. Currently, English is the only supported language.
", "DocumentClassifierProperties$LanguageCode": "The language code for the language of the documents that the classifier was trained on.
", "EntitiesDetectionJobProperties$LanguageCode": "The language code of the input documents.
", "EntityRecognizerProperties$LanguageCode": "The language of the input documents. All documents must be in the same language. Only English (\"en\") is currently supported.
", @@ -1386,7 +1425,7 @@ "StartKeyPhrasesDetectionJobRequest$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.
", "StartPiiEntitiesDetectionJobRequest$LanguageCode": "The language of the input documents. Currently, English is the only valid language.
", "StartSentimentDetectionJobRequest$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.
", - "StartTargetedSentimentDetectionJobRequest$LanguageCode": "The language of the input documents. Currently, English is the only valid language.
", + "StartTargetedSentimentDetectionJobRequest$LanguageCode": "The language of the input documents. Currently, English is the only supported language.
", "TargetedSentimentDetectionJobProperties$LanguageCode": "The language code of the input documents.
" } }, @@ -1496,6 +1535,12 @@ "ClassifyDocumentResponse$Classes": "The classes used by the document being analyzed. These are used for multi-class trained models. Individual classes are mutually exclusive and each document is expected to have only a single class assigned to it. For example, an animal can be a dog or a cat, but not both at the same time.
" } }, + "ListOfDescriptiveMentionIndices": { + "base": null, + "refs": { + "TargetedSentimentEntity$DescriptiveMentionIndex": "One or more index into the Mentions array that provides the best name for the entity group.
" + } + }, "ListOfDetectDominantLanguageResult": { "base": null, "refs": { @@ -1526,6 +1571,12 @@ "BatchDetectSyntaxResponse$ResultList": "A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.
A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.
One or more Entity objects, one for each entity detected in the document.
", - "DetectEntitiesResponse$Entities": "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.
If your request uses a custom entity recognition model, Amazon Comprehend detects the entities that the model is trained to recognize. Otherwise, it detects the default entity types. For a list of default entity types, see how-entities.
" + "DetectEntitiesResponse$Entities": "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.
If your request uses a custom entity recognition model, Amazon Comprehend detects the entities that the model is trained to recognize. Otherwise, it detects the default entity types. For a list of default entity types, see Entities in the Comprehend Developer Guide.
" } }, "ListOfEntityLabels": { @@ -1565,6 +1616,12 @@ "ClassifyDocumentResponse$Labels": "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 can be just an action movie, or it can be an action movie, a science fiction movie, and a comedy, all at the same time.
" } }, + "ListOfMentions": { + "base": null, + "refs": { + "TargetedSentimentEntity$Mentions": "An array of mentions of the entity in the document. The array represents a co-reference group. See Co-reference group for an example.
" + } + }, "ListOfPiiEntities": { "base": null, "refs": { @@ -1581,7 +1638,14 @@ "base": null, "refs": { "BatchDetectSyntaxItemResult$SyntaxTokens": "The syntax tokens for the words in the document, one token for each word.
", - "DetectSyntaxResponse$SyntaxTokens": "A collection of syntax tokens describing the text. For each token, the response provides the text, the token type, where the text begins and ends, and the level of confidence that Amazon Comprehend has that the token is correct. For a list of token types, see how-syntax.
" + "DetectSyntaxResponse$SyntaxTokens": "A collection of syntax tokens describing the text. For each token, the response provides the text, the token type, where the text begins and ends, and the level of confidence that Amazon Comprehend has that the token is correct. For a list of token types, see Syntax in the Comprehend Developer Guide.
" + } + }, + "ListOfTargetedSentimentEntities": { + "base": null, + "refs": { + "BatchDetectTargetedSentimentItemResult$Entities": "An array of targeted sentiment entities.
", + "DetectTargetedSentimentResponse$Entities": "Targeted sentiment analysis for each of the entities identified in the input text.
" } }, "ListPiiEntitiesDetectionJobsRequest": { @@ -1659,6 +1723,12 @@ "ListTopicsDetectionJobsRequest$MaxResults": "The maximum number of results to return in each page. The default is 100.
" } }, + "MentionSentiment": { + "base": "Contains the sentiment and sentiment score for one mention of an entity.
For more information about targeted sentiment, see Targeted sentiment.
", + "refs": { + "TargetedSentimentMention$MentionSentiment": "Contains the sentiment and sentiment score for the mention.
" + } + }, "ModelStatus": { "base": null, "refs": { @@ -1699,9 +1769,9 @@ } }, "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 how-syntax.
", + "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": { - "SyntaxToken$PartOfSpeech": "Provides the part of speech label and the confidence level that Amazon Comprehend has that the part of speech was correctly identified. For more information, see how-syntax.
" + "SyntaxToken$PartOfSpeech": "Provides the part of speech label and the confidence level that Amazon Comprehend has that the part of speech was correctly identified. For more information, see Syntax in the Comprehend Developer Guide.
" } }, "PartOfSpeechTagType": { @@ -1824,10 +1894,10 @@ "AugmentedManifestsListItem$AnnotationDataS3Uri": "The S3 prefix to the annotation files that are referred in the augmented manifest file.
", "AugmentedManifestsListItem$SourceDocumentsS3Uri": "The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.
", "DocumentClassifierInputDataConfig$S3Uri": "The Amazon S3 URI for the input data. The S3 bucket must be in the same region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of input files.
For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.
This parameter is required if you set DataFormat to COMPREHEND_CSV.
The Amazon S3 URI for the input data. The Amazon S3 bucket must be in the same AWS Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of input files.
", + "DocumentClassifierInputDataConfig$TestS3Uri": "This specifies the Amazon S3 location where the test annotations for an entity recognizer are located. The URI must be in the same AWS Region as the API endpoint that you are calling.
", "DocumentClassifierOutputDataConfig$S3Uri": "When you use the OutputDataConfig object while creating a custom classifier, you specify the Amazon S3 location where you want to write the confusion matrix. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of this output file.
When the custom classifier job is finished, the service creates the output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the confusion matrix.
Specifies the Amazon S3 location where the annotations for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.
", - "EntityRecognizerAnnotations$TestS3Uri": "This specifies the Amazon S3 location where the test annotations for an entity recognizer are located. The URI must be in the same AWS Region as the API endpoint that you are calling.
", + "EntityRecognizerAnnotations$TestS3Uri": "Specifies the Amazon S3 location where the test annotations for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.
", "EntityRecognizerDocuments$S3Uri": "Specifies the Amazon S3 location where the training documents for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.
", "EntityRecognizerDocuments$TestS3Uri": "Specifies the Amazon S3 location where the test documents for an entity recognizer are located. The URI must be in the same AWS Region as the API endpoint that you are calling.
", "EntityRecognizerEntityList$S3Uri": "Specifies the Amazon S3 location where the entity list is located. The URI must be in the same region as the API endpoint that you are calling.
", @@ -1871,14 +1941,16 @@ "base": "Describes the level of confidence that Amazon Comprehend has in the accuracy of its detection of sentiments.
", "refs": { "BatchDetectSentimentItemResult$SentimentScore": "The level of confidence that Amazon Comprehend has in the accuracy of its sentiment detection.
", - "DetectSentimentResponse$SentimentScore": "An object that lists the sentiments, and their corresponding confidence levels.
" + "DetectSentimentResponse$SentimentScore": "An object that lists the sentiments, and their corresponding confidence levels.
", + "MentionSentiment$SentimentScore": null } }, "SentimentType": { "base": null, "refs": { "BatchDetectSentimentItemResult$Sentiment": "The sentiment detected in the document.
", - "DetectSentimentResponse$Sentiment": "The inferred sentiment that Amazon Comprehend has the highest level of confidence in.
" + "DetectSentimentResponse$Sentiment": "The inferred sentiment that Amazon Comprehend has the highest level of confidence in.
", + "MentionSentiment$Sentiment": "The sentiment of the mention.
" } }, "Split": { @@ -2074,8 +2146,8 @@ "BatchItemError$ErrorMessage": "A text description of the error.
", "BatchSizeLimitExceededException$Message": null, "ConcurrentModificationException$Message": null, - "ContainsPiiEntitiesRequest$Text": "Creates a new document classification request to analyze a single document in real-time, returning personally identifiable information (PII) entity labels.
", - "DetectPiiEntitiesRequest$Text": "A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.
", + "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.
", "DocumentClass$Name": "The name of the class.
", "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.
", @@ -2119,6 +2191,7 @@ "ResourceNotFoundException$Message": null, "ResourceUnavailableException$Message": 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, "TooManyRequestsException$Message": null, "TooManyTagKeysException$Message": null, @@ -2232,6 +2305,24 @@ "ListTargetedSentimentDetectionJobsResponse$TargetedSentimentDetectionJobPropertiesList": "A list containing the properties of each job that is returned.
" } }, + "TargetedSentimentEntity": { + "base": "Information about one of the entities found by targeted sentiment analysis.
For more information about targeted sentiment, see Targeted sentiment.
", + "refs": { + "ListOfTargetedSentimentEntities$member": null + } + }, + "TargetedSentimentEntityType": { + "base": null, + "refs": { + "TargetedSentimentMention$Type": "The type of the entity. Amazon Comprehend supports a variety of entity types.
" + } + }, + "TargetedSentimentMention": { + "base": "Information about one mention of an entity. The mention information includes the location of the mention in the text and the sentiment of the mention.
For more information about targeted sentiment, see Targeted sentiment.
", + "refs": { + "ListOfMentions$member": null + } + }, "TextSizeLimitExceededException": { "base": "The size of the input text exceeds the limit. Use a smaller document.
", "refs": { @@ -2333,7 +2424,7 @@ } }, "UnsupportedLanguageException": { - "base": "Amazon Comprehend can't process the language of the input text. For custom entity recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages, see supported-languages.
", + "base": "Amazon Comprehend can't process the language of the input text. For custom entity recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages, Supported languages in the Comprehend Developer Guide.
", "refs": { } }, diff --git a/models/apis/s3control/2018-08-20/api-2.json b/models/apis/s3control/2018-08-20/api-2.json index b8e68a41c8..94c99edff3 100644 --- a/models/apis/s3control/2018-08-20/api-2.json +++ b/models/apis/s3control/2018-08-20/api-2.json @@ -416,6 +416,18 @@ "hostPrefix":"{AccountId}." } }, + "GetBucketVersioning":{ + "name":"GetBucketVersioning", + "http":{ + "method":"GET", + "requestUri":"/v20180820/bucket/{name}/versioning" + }, + "input":{"shape":"GetBucketVersioningRequest"}, + "output":{"shape":"GetBucketVersioningResult"}, + "endpoint":{ + "hostPrefix":"{AccountId}." + } + }, "GetJobTagging":{ "name":"GetJobTagging", "http":{ @@ -674,6 +686,18 @@ }, "httpChecksumRequired":true }, + "PutBucketVersioning":{ + "name":"PutBucketVersioning", + "http":{ + "method":"PUT", + "requestUri":"/v20180820/bucket/{name}/versioning" + }, + "input":{"shape":"PutBucketVersioningRequest"}, + "endpoint":{ + "hostPrefix":"{AccountId}." + }, + "httpChecksumRequired":true + }, "PutJobTagging":{ "name":"PutJobTagging", "http":{ @@ -975,6 +999,13 @@ "max":255, "min":3 }, + "BucketVersioningStatus":{ + "type":"string", + "enum":[ + "Enabled", + "Suspended" + ] + }, "Buckets":{ "type":"list", "member":{ @@ -1907,6 +1938,36 @@ "TagSet":{"shape":"S3TagSet"} } }, + "GetBucketVersioningRequest":{ + "type":"structure", + "required":[ + "AccountId", + "Bucket" + ], + "members":{ + "AccountId":{ + "shape":"AccountId", + "hostLabel":true, + "location":"header", + "locationName":"x-amz-account-id" + }, + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"name" + } + } + }, + "GetBucketVersioningResult":{ + "type":"structure", + "members":{ + "Status":{"shape":"BucketVersioningStatus"}, + "MFADelete":{ + "shape":"MFADeleteStatus", + "locationName":"MfaDelete" + } + } + }, "GetJobTaggingRequest":{ "type":"structure", "required":[ @@ -2742,6 +2803,21 @@ } }, "Location":{"type":"string"}, + "MFA":{"type":"string"}, + "MFADelete":{ + "type":"string", + "enum":[ + "Enabled", + "Disabled" + ] + }, + "MFADeleteStatus":{ + "type":"string", + "enum":[ + "Enabled", + "Disabled" + ] + }, "ManifestPrefixString":{ "type":"string", "max":512, @@ -3211,6 +3287,38 @@ }, "payload":"Tagging" }, + "PutBucketVersioningRequest":{ + "type":"structure", + "required":[ + "AccountId", + "Bucket", + "VersioningConfiguration" + ], + "members":{ + "AccountId":{ + "shape":"AccountId", + "hostLabel":true, + "location":"header", + "locationName":"x-amz-account-id" + }, + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"name" + }, + "MFA":{ + "shape":"MFA", + "location":"header", + "locationName":"x-amz-mfa" + }, + "VersioningConfiguration":{ + "shape":"VersioningConfiguration", + "locationName":"VersioningConfiguration", + "xmlNamespace":{"uri":"http://awss3control.amazonaws.com/doc/2018-08-20/"} + } + }, + "payload":"VersioningConfiguration" + }, "PutJobTaggingRequest":{ "type":"structure", "required":[ @@ -4073,6 +4181,16 @@ "StatusUpdateReason":{"shape":"JobStatusUpdateReason"} } }, + "VersioningConfiguration":{ + "type":"structure", + "members":{ + "MFADelete":{ + "shape":"MFADelete", + "locationName":"MfaDelete" + }, + "Status":{"shape":"BucketVersioningStatus"} + } + }, "VpcConfiguration":{ "type":"structure", "required":["VpcId"], diff --git a/models/apis/s3control/2018-08-20/docs-2.json b/models/apis/s3control/2018-08-20/docs-2.json index 2c824314cd..92b60c858b 100644 --- a/models/apis/s3control/2018-08-20/docs-2.json +++ b/models/apis/s3control/2018-08-20/docs-2.json @@ -2,19 +2,19 @@ "version": "2.0", "service": "Amazon Web Services S3 Control provides access to Amazon S3 control plane actions.
", "operations": { - "CreateAccessPoint": "Creates an access point and associates it with the specified bucket. For more information, see Managing Data Access with Amazon S3 Access Points in the Amazon S3 User Guide.
S3 on Outposts only supports VPC-style access points.
For more information, see Accessing Amazon S3 on Outposts using virtual private cloud (VPC) only access points in the Amazon S3 User Guide.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
The following actions are related to CreateAccessPoint:
Creates an access point and associates it with the specified bucket. For more information, see Managing Data Access with Amazon S3 Access Points in the Amazon S3 User Guide.
S3 on Outposts only supports VPC-style access points.
For more information, see Accessing Amazon S3 on Outposts using virtual private cloud (VPC) only access points in the Amazon S3 User Guide.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following actions are related to CreateAccessPoint:
Creates an Object Lambda Access Point. For more information, see Transforming objects with Object Lambda Access Points in the Amazon S3 User Guide.
The following actions are related to CreateAccessPointForObjectLambda:
This action creates an Amazon S3 on Outposts bucket. To create an S3 bucket, see Create Bucket in the Amazon S3 API Reference.
Creates a new Outposts bucket. By creating the bucket, you become the bucket owner. To create an Outposts bucket, you must have S3 on Outposts. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.
Not every string is an acceptable bucket name. For information on bucket naming restrictions, see Working with Amazon S3 Buckets.
S3 on Outposts buckets support:
Tags
LifecycleConfigurations for deleting expired objects
For a complete list of restrictions and Amazon S3 feature limitations on S3 on Outposts, see Amazon S3 on Outposts Restrictions and Limitations.
For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and x-amz-outpost-id in your API request, see the Examples section.
The following actions are related to CreateBucket for Amazon S3 on Outposts:
You can use S3 Batch Operations to perform large-scale batch actions on Amazon S3 objects. Batch Operations can run a single action on lists of Amazon S3 objects that you specify. For more information, see S3 Batch Operations in the Amazon S3 User Guide.
This action creates a S3 Batch Operations job.
Related actions include:
", "CreateMultiRegionAccessPoint": "Creates a Multi-Region Access Point and associates it with the specified buckets. For more information about creating Multi-Region Access Points, see Creating Multi-Region Access Points in the Amazon S3 User Guide.
This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.
This request is asynchronous, meaning that you might receive a response before the command has completed. When this request provides a response, it provides a token that you can use to monitor the status of the request with DescribeMultiRegionAccessPointOperation.
The following actions are related to CreateMultiRegionAccessPoint:
Deletes the specified access point.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
The following actions are related to DeleteAccessPoint:
Deletes the specified access point.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following actions are related to DeleteAccessPoint:
Deletes the specified Object Lambda Access Point.
The following actions are related to DeleteAccessPointForObjectLambda:
Deletes the access point policy for the specified access point.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
The following actions are related to DeleteAccessPointPolicy:
Deletes the access point policy for the specified access point.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following actions are related to DeleteAccessPointPolicy:
Removes the resource policy for an Object Lambda Access Point.
The following actions are related to DeleteAccessPointPolicyForObjectLambda:
This action deletes an Amazon S3 on Outposts bucket. To delete an S3 bucket, see DeleteBucket in the Amazon S3 API Reference.
Deletes the Amazon S3 on Outposts bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
Related Resources
", - "DeleteBucketLifecycleConfiguration": "This action deletes an Amazon S3 on Outposts bucket's lifecycle configuration. To delete an S3 bucket's lifecycle configuration, see DeleteBucketLifecycle in the Amazon S3 API Reference.
Deletes the lifecycle configuration from the specified Outposts bucket. Amazon S3 on Outposts removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 on Outposts no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.
To use this action, you must have permission to perform the s3-outposts:DeleteLifecycleConfiguration action. By default, the bucket owner has this permission and the Outposts bucket owner can grant this permission to others.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
For more information about object expiration, see Elements to Describe Lifecycle Actions.
Related actions include:
", - "DeleteBucketPolicy": "This action deletes an Amazon S3 on Outposts bucket policy. To delete an S3 bucket policy, see DeleteBucketPolicy in the Amazon S3 API Reference.
This implementation of the DELETE action uses the policy subresource to delete the policy of a specified Amazon S3 on Outposts bucket. If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the s3-outposts:DeleteBucketPolicy permissions on the specified Outposts bucket and belong to the bucket owner's account to use this action. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.
If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.
As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.
For more information about bucket policies, see Using Bucket Policies and User Policies.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
The following actions are related to DeleteBucketPolicy:
This action deletes an Amazon S3 on Outposts bucket's tags. To delete an S3 bucket tags, see DeleteBucketTagging in the Amazon S3 API Reference.
Deletes the tags from the Outposts bucket. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.
To use this action, you must have permission to perform the PutBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
The following actions are related to DeleteBucketTagging:
This action deletes an Amazon S3 on Outposts bucket. To delete an S3 bucket, see DeleteBucket in the Amazon S3 API Reference.
Deletes the Amazon S3 on Outposts bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
Related Resources
", + "DeleteBucketLifecycleConfiguration": "This action deletes an Amazon S3 on Outposts bucket's lifecycle configuration. To delete an S3 bucket's lifecycle configuration, see DeleteBucketLifecycle in the Amazon S3 API Reference.
Deletes the lifecycle configuration from the specified Outposts bucket. Amazon S3 on Outposts removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 on Outposts no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.
To use this action, you must have permission to perform the s3-outposts:DeleteLifecycleConfiguration action. By default, the bucket owner has this permission and the Outposts bucket owner can grant this permission to others.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
For more information about object expiration, see Elements to Describe Lifecycle Actions.
Related actions include:
", + "DeleteBucketPolicy": "This action deletes an Amazon S3 on Outposts bucket policy. To delete an S3 bucket policy, see DeleteBucketPolicy in the Amazon S3 API Reference.
This implementation of the DELETE action uses the policy subresource to delete the policy of a specified Amazon S3 on Outposts bucket. If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the s3-outposts:DeleteBucketPolicy permissions on the specified Outposts bucket and belong to the bucket owner's account to use this action. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.
If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.
As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.
For more information about bucket policies, see Using Bucket Policies and User Policies.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following actions are related to DeleteBucketPolicy:
This action deletes an Amazon S3 on Outposts bucket's tags. To delete an S3 bucket tags, see DeleteBucketTagging in the Amazon S3 API Reference.
Deletes the tags from the Outposts bucket. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.
To use this action, you must have permission to perform the PutBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following actions are related to DeleteBucketTagging:
Removes the entire tag set from the specified S3 Batch Operations job. To use this operation, you must have permission to perform the s3:DeleteJobTagging action. For more information, see Controlling access and labeling jobs using tags in the Amazon S3 User Guide.
Related actions include:
", "DeleteMultiRegionAccessPoint": "Deletes a Multi-Region Access Point. This action does not delete the buckets associated with the Multi-Region Access Point, only the Multi-Region Access Point itself.
This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.
This request is asynchronous, meaning that you might receive a response before the command has completed. When this request provides a response, it provides a token that you can use to monitor the status of the request with DescribeMultiRegionAccessPointOperation.
The following actions are related to DeleteMultiRegionAccessPoint:
Removes the PublicAccessBlock configuration for an Amazon Web Services account. For more information, see Using Amazon S3 block public access.
Related actions include:
", @@ -22,17 +22,18 @@ "DeleteStorageLensConfigurationTagging": "Deletes the Amazon S3 Storage Lens configuration tags. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.
To use this action, you must have permission to perform the s3:DeleteStorageLensConfigurationTagging action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.
Retrieves the configuration parameters and status for a Batch Operations job. For more information, see S3 Batch Operations in the Amazon S3 User Guide.
Related actions include:
", "DescribeMultiRegionAccessPointOperation": "Retrieves the status of an asynchronous request to manage a Multi-Region Access Point. For more information about managing Multi-Region Access Points and how asynchronous requests work, see Managing Multi-Region Access Points in the Amazon S3 User Guide.
The following actions are related to GetMultiRegionAccessPoint:
Returns configuration information about the specified access point.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
The following actions are related to GetAccessPoint:
Returns configuration information about the specified access point.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following actions are related to GetAccessPoint:
Returns configuration for an Object Lambda Access Point.
The following actions are related to GetAccessPointConfigurationForObjectLambda:
Returns configuration information about the specified Object Lambda Access Point
The following actions are related to GetAccessPointForObjectLambda:
Returns the access point policy associated with the specified access point.
The following actions are related to GetAccessPointPolicy:
Returns the resource policy for an Object Lambda Access Point.
The following actions are related to GetAccessPointPolicyForObjectLambda:
Indicates whether the specified access point currently has a policy that allows public access. For more information about public access through access points, see Managing Data Access with Amazon S3 access points in the Amazon S3 User Guide.
", "GetAccessPointPolicyStatusForObjectLambda": "Returns the status of the resource policy associated with an Object Lambda Access Point.
", - "GetBucket": "Gets an Amazon S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
If you are using an identity other than the root user of the Amazon Web Services account that owns the Outposts bucket, the calling identity must have the s3-outposts:GetBucket permissions on the specified Outposts bucket and belong to the Outposts bucket owner's account in order to use this action. Only users from Outposts bucket owner account with the right permissions can perform actions on an Outposts bucket.
If you don't have s3-outposts:GetBucket permissions or you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 403 Access Denied error.
The following actions are related to GetBucket for Amazon S3 on Outposts:
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
This action gets an Amazon S3 on Outposts bucket's lifecycle configuration. To get an S3 bucket's lifecycle configuration, see GetBucketLifecycleConfiguration in the Amazon S3 API Reference.
Returns the lifecycle configuration information set on the Outposts bucket. For more information, see Using Amazon S3 on Outposts and for information about lifecycle configuration, see Object Lifecycle Management in Amazon S3 User Guide.
To use this action, you must have permission to perform the s3-outposts:GetLifecycleConfiguration action. The Outposts bucket owner has this permission, by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
GetBucketLifecycleConfiguration has the following special error:
Error code: NoSuchLifecycleConfiguration
Description: The lifecycle configuration does not exist.
HTTP Status Code: 404 Not Found
SOAP Fault Code Prefix: Client
The following actions are related to GetBucketLifecycleConfiguration:
This action gets a bucket policy for an Amazon S3 on Outposts bucket. To get a policy for an S3 bucket, see GetBucketPolicy in the Amazon S3 API Reference.
Returns the policy of a specified Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the GetBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this action.
Only users from Outposts bucket owner account with the right permissions can perform actions on an Outposts bucket. If you don't have s3-outposts:GetBucketPolicy permissions or you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 403 Access Denied error.
As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.
For more information about bucket policies, see Using Bucket Policies and User Policies.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
The following actions are related to GetBucketPolicy:
This action gets an Amazon S3 on Outposts bucket's tags. To get an S3 bucket tags, see GetBucketTagging in the Amazon S3 API Reference.
Returns the tag set associated with the Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
To use this action, you must have permission to perform the GetBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others.
GetBucketTagging has the following special error:
Error code: NoSuchTagSetError
Description: There is no tag set associated with the bucket.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
The following actions are related to GetBucketTagging:
Gets an Amazon S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
If you are using an identity other than the root user of the Amazon Web Services account that owns the Outposts bucket, the calling identity must have the s3-outposts:GetBucket permissions on the specified Outposts bucket and belong to the Outposts bucket owner's account in order to use this action. Only users from Outposts bucket owner account with the right permissions can perform actions on an Outposts bucket.
If you don't have s3-outposts:GetBucket permissions or you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 403 Access Denied error.
The following actions are related to GetBucket for Amazon S3 on Outposts:
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
This action gets an Amazon S3 on Outposts bucket's lifecycle configuration. To get an S3 bucket's lifecycle configuration, see GetBucketLifecycleConfiguration in the Amazon S3 API Reference.
Returns the lifecycle configuration information set on the Outposts bucket. For more information, see Using Amazon S3 on Outposts and for information about lifecycle configuration, see Object Lifecycle Management in Amazon S3 User Guide.
To use this action, you must have permission to perform the s3-outposts:GetLifecycleConfiguration action. The Outposts bucket owner has this permission, by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
GetBucketLifecycleConfiguration has the following special error:
Error code: NoSuchLifecycleConfiguration
Description: The lifecycle configuration does not exist.
HTTP Status Code: 404 Not Found
SOAP Fault Code Prefix: Client
The following actions are related to GetBucketLifecycleConfiguration:
This action gets a bucket policy for an Amazon S3 on Outposts bucket. To get a policy for an S3 bucket, see GetBucketPolicy in the Amazon S3 API Reference.
Returns the policy of a specified Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the GetBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this action.
Only users from Outposts bucket owner account with the right permissions can perform actions on an Outposts bucket. If you don't have s3-outposts:GetBucketPolicy permissions or you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 403 Access Denied error.
As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.
For more information about bucket policies, see Using Bucket Policies and User Policies.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following actions are related to GetBucketPolicy:
This action gets an Amazon S3 on Outposts bucket's tags. To get an S3 bucket tags, see GetBucketTagging in the Amazon S3 API Reference.
Returns the tag set associated with the Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
To use this action, you must have permission to perform the GetBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others.
GetBucketTagging has the following special error:
Error code: NoSuchTagSetError
Description: There is no tag set associated with the bucket.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following actions are related to GetBucketTagging:
This operation returns the versioning state only for S3 on Outposts buckets. To return the versioning state for an S3 bucket, see GetBucketVersioning in the Amazon S3 API Reference.
Returns the versioning state for an S3 on Outposts bucket. With versioning, you can save multiple distinct copies of your data and recover from unintended user actions and application failures.
If you've never set versioning on your bucket, it has no versioning state. In that case, the GetBucketVersioning request does not return a versioning state value.
For more information about versioning, see Versioning in the Amazon S3 User Guide.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following operations are related to GetBucketVersioning for S3 on Outposts.
Returns the tags on an S3 Batch Operations job. To use this operation, you must have permission to perform the s3:GetJobTagging action. For more information, see Controlling access and labeling jobs using tags in the Amazon S3 User Guide.
Related actions include:
", "GetMultiRegionAccessPoint": "Returns configuration information about the specified Multi-Region Access Point.
This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.
The following actions are related to GetMultiRegionAccessPoint:
Returns the access control policy of the specified Multi-Region Access Point.
This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.
The following actions are related to GetMultiRegionAccessPointPolicy:
Retrieves the PublicAccessBlock configuration for an Amazon Web Services account. For more information, see Using Amazon S3 block public access.
Related actions include:
", "GetStorageLensConfiguration": "Gets the Amazon S3 Storage Lens configuration. For more information, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.
To use this action, you must have permission to perform the s3:GetStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.
Gets the tags of Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.
To use this action, you must have permission to perform the s3:GetStorageLensConfigurationTagging action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.
Returns a list of the access points currently associated with the specified bucket. You can retrieve up to 1000 access points per call. If the specified bucket has more than 1,000 access points (or the number specified in maxResults, whichever is less), the response will include a continuation token that you can use to list the additional access points.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
The following actions are related to ListAccessPoints:
Returns a list of the access points currently associated with the specified bucket. You can retrieve up to 1000 access points per call. If the specified bucket has more than 1,000 access points (or the number specified in maxResults, whichever is less), the response will include a continuation token that you can use to list the additional access points.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following actions are related to ListAccessPoints:
Returns some or all (up to 1,000) access points associated with the Object Lambda Access Point per call. If there are more access points than what can be returned in one call, the response will include a continuation token that you can use to list the additional access points.
The following actions are related to ListAccessPointsForObjectLambda:
Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the Amazon Web Services account making the request. For more information, see S3 Batch Operations in the Amazon S3 User Guide.
Related actions include:
", "ListMultiRegionAccessPoints": "Returns a list of the Multi-Region Access Points currently associated with the specified Amazon Web Services account. Each call can return up to 100 Multi-Region Access Points, the maximum number of Multi-Region Access Points that can be associated with a single account.
This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.
The following actions are related to ListMultiRegionAccessPoint:
Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated sender of the request. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and x-amz-outpost-id in your request, see the Examples section.
Gets a list of Amazon S3 Storage Lens configurations. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.
To use this action, you must have permission to perform the s3:ListStorageLensConfigurations action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.
Replaces configuration for an Object Lambda Access Point.
The following actions are related to PutAccessPointConfigurationForObjectLambda:
Associates an access policy with the specified access point. Each access point can have only one policy, so a request made to this API replaces any existing policy associated with the specified access point.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
The following actions are related to PutAccessPointPolicy:
Associates an access policy with the specified access point. Each access point can have only one policy, so a request made to this API replaces any existing policy associated with the specified access point.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following actions are related to PutAccessPointPolicy:
Creates or replaces resource policy for an Object Lambda Access Point. For an example policy, see Creating Object Lambda Access Points in the Amazon S3 User Guide.
The following actions are related to PutAccessPointPolicyForObjectLambda:
This action puts a lifecycle configuration to an Amazon S3 on Outposts bucket. To put a lifecycle configuration to an S3 bucket, see PutBucketLifecycleConfiguration in the Amazon S3 API Reference.
Creates a new lifecycle configuration for the S3 on Outposts bucket or replaces an existing lifecycle configuration. Outposts buckets only support lifecycle configurations that delete/expire objects after a certain period of time and abort incomplete multipart uploads.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
The following actions are related to PutBucketLifecycleConfiguration:
This action puts a bucket policy to an Amazon S3 on Outposts bucket. To put a policy on an S3 bucket, see PutBucketPolicy in the Amazon S3 API Reference.
Applies an Amazon S3 bucket policy to an Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
If you are using an identity other than the root user of the Amazon Web Services account that owns the Outposts bucket, the calling identity must have the PutBucketPolicy permissions on the specified Outposts bucket and belong to the bucket owner's account in order to use this action.
If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.
As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.
For more information about bucket policies, see Using Bucket Policies and User Policies.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
The following actions are related to PutBucketPolicy:
This action puts tags on an Amazon S3 on Outposts bucket. To put tags on an S3 bucket, see PutBucketTagging in the Amazon S3 API Reference.
Sets the tags for an S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this, sign up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see Cost allocation and tagging.
Within a bucket, if you add a tag that has the same key as an existing tag, the new value overwrites the old value. For more information, see Using cost allocation in Amazon S3 bucket tags.
To use this action, you must have permissions to perform the s3-outposts:PutBucketTagging action. The Outposts bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing access permissions to your Amazon S3 resources.
PutBucketTagging has the following special errors:
Error code: InvalidTagError
Description: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For information about tag restrictions, see User-Defined Tag Restrictions and Amazon Web Services-Generated Cost Allocation Tag Restrictions.
Error code: MalformedXMLError
Description: The XML provided does not match the schema.
Error code: OperationAbortedError
Description: A conflicting conditional action is currently in progress against this resource. Try again.
Error code: InternalError
Description: The service was unable to apply the provided tag to the bucket.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
The following actions are related to PutBucketTagging:
This action puts a lifecycle configuration to an Amazon S3 on Outposts bucket. To put a lifecycle configuration to an S3 bucket, see PutBucketLifecycleConfiguration in the Amazon S3 API Reference.
Creates a new lifecycle configuration for the S3 on Outposts bucket or replaces an existing lifecycle configuration. Outposts buckets only support lifecycle configurations that delete/expire objects after a certain period of time and abort incomplete multipart uploads.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following actions are related to PutBucketLifecycleConfiguration:
This action puts a bucket policy to an Amazon S3 on Outposts bucket. To put a policy on an S3 bucket, see PutBucketPolicy in the Amazon S3 API Reference.
Applies an Amazon S3 bucket policy to an Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
If you are using an identity other than the root user of the Amazon Web Services account that owns the Outposts bucket, the calling identity must have the PutBucketPolicy permissions on the specified Outposts bucket and belong to the bucket owner's account in order to use this action.
If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.
As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.
For more information about bucket policies, see Using Bucket Policies and User Policies.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following actions are related to PutBucketPolicy:
This action puts tags on an Amazon S3 on Outposts bucket. To put tags on an S3 bucket, see PutBucketTagging in the Amazon S3 API Reference.
Sets the tags for an S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this, sign up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see Cost allocation and tagging.
Within a bucket, if you add a tag that has the same key as an existing tag, the new value overwrites the old value. For more information, see Using cost allocation in Amazon S3 bucket tags.
To use this action, you must have permissions to perform the s3-outposts:PutBucketTagging action. The Outposts bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing access permissions to your Amazon S3 resources.
PutBucketTagging has the following special errors:
Error code: InvalidTagError
Description: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For information about tag restrictions, see User-Defined Tag Restrictions and Amazon Web Services-Generated Cost Allocation Tag Restrictions.
Error code: MalformedXMLError
Description: The XML provided does not match the schema.
Error code: OperationAbortedError
Description: A conflicting conditional action is currently in progress against this resource. Try again.
Error code: InternalError
Description: The service was unable to apply the provided tag to the bucket.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following actions are related to PutBucketTagging:
This operation sets the versioning state only for S3 on Outposts buckets. To set the versioning state for an S3 bucket, see PutBucketVersioning in the Amazon S3 API Reference.
Sets the versioning state for an S3 on Outposts bucket. With versioning, you can save multiple distinct copies of your data and recover from unintended user actions and application failures.
You can set the versioning state to one of the following:
Enabled - Enables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID.
Suspended - Suspends versioning for the objects in the bucket. All objects added to the bucket receive the version ID null.
If you've never set versioning on your bucket, it has no versioning state. In that case, a GetBucketVersioning request does not return a versioning state value.
When you enable S3 Versioning, for each object in your bucket, you have a current version and zero or more noncurrent versions. You can configure your bucket S3 Lifecycle rules to expire noncurrent versions after a specified time period. For more information, see Creating and managing a lifecycle configuration for your S3 on Outposts bucket in the Amazon S3 User Guide.
If you have an object expiration lifecycle policy in your non-versioned bucket and you want to maintain the same permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy. The noncurrent expiration lifecycle policy will manage the deletes of the noncurrent object versions in the version-enabled bucket. For more information, see Versioning in the Amazon S3 User Guide.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following operations are related to PutBucketVersioning for S3 on Outposts.
Sets the supplied tag-set on an S3 Batch Operations job.
A tag is a key-value pair. You can associate S3 Batch Operations tags with any job by sending a PUT request against the tagging subresource that is associated with the job. To modify the existing tag set, you can either replace the existing tag set entirely, or make changes within the existing tag set by retrieving the existing tag set using GetJobTagging, modify that tag set, and use this action to replace the tag set with the one you modified. For more information, see Controlling access and labeling jobs using tags in the Amazon S3 User Guide.
If you send this request with an empty tag set, Amazon S3 deletes the existing tag set on the Batch Operations job. If you use this method, you are charged for a Tier 1 Request (PUT). For more information, see Amazon S3 pricing.
For deleting existing tags for your Batch Operations job, a DeleteJobTagging request is preferred because it achieves the same result without incurring charges.
A few things to consider about using tags:
Amazon S3 limits the maximum number of tags to 50 tags per job.
You can associate up to 50 tags with a job as long as they have unique tag keys.
A tag key can be up to 128 Unicode characters in length, and tag values can be up to 256 Unicode characters in length.
The key and values are case sensitive.
For tagging-related restrictions related to characters and encodings, see User-Defined Tag Restrictions in the Billing and Cost Management User Guide.
To use this action, you must have permission to perform the s3:PutJobTagging action.
Related actions include:
", "PutMultiRegionAccessPointPolicy": "Associates an access control policy with the specified Multi-Region Access Point. Each Multi-Region Access Point can have only one policy, so a request made to this action replaces any existing policy that is associated with the specified Multi-Region Access Point.
This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.
The following actions are related to PutMultiRegionAccessPointPolicy:
Creates or modifies the PublicAccessBlock configuration for an Amazon Web Services account. For this operation, users must have the s3:PutBucketPublicAccessBlock permission. For more information, see Using Amazon S3 block public access.
Related actions include:
", + "PutPublicAccessBlock": "Creates or modifies the PublicAccessBlock configuration for an Amazon Web Services account. For this operation, users must have the s3:PutAccountPublicAccessBlock permission. For more information, see Using Amazon S3 block public access.
Related actions include:
", "PutStorageLensConfiguration": "Puts an Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Working with Amazon S3 Storage Lens in the Amazon S3 User Guide.
To use this action, you must have permission to perform the s3:PutStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.
Put or replace tags on an existing Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.
To use this action, you must have permission to perform the s3:PutStorageLensConfigurationTagging action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.
Updates an existing S3 Batch Operations job's priority. For more information, see S3 Batch Operations in the Amazon S3 User Guide.
Related actions include:
", @@ -126,6 +128,7 @@ "GetBucketPolicyRequest$AccountId": "The Amazon Web Services account ID of the Outposts bucket.
", "GetBucketRequest$AccountId": "The Amazon Web Services account ID of the Outposts bucket.
", "GetBucketTaggingRequest$AccountId": "The Amazon Web Services account ID of the Outposts bucket.
", + "GetBucketVersioningRequest$AccountId": "The Amazon Web Services account ID of the S3 on Outposts bucket.
", "GetJobTaggingRequest$AccountId": "The Amazon Web Services account ID associated with the S3 Batch Operations job.
", "GetMultiRegionAccessPointPolicyRequest$AccountId": "The Amazon Web Services account ID for the owner of the Multi-Region Access Point.
", "GetMultiRegionAccessPointPolicyStatusRequest$AccountId": "The Amazon Web Services account ID for the owner of the Multi-Region Access Point.
", @@ -145,6 +148,7 @@ "PutBucketLifecycleConfigurationRequest$AccountId": "The Amazon Web Services account ID of the Outposts bucket.
", "PutBucketPolicyRequest$AccountId": "The Amazon Web Services account ID of the Outposts bucket.
", "PutBucketTaggingRequest$AccountId": "The Amazon Web Services account ID of the Outposts bucket.
", + "PutBucketVersioningRequest$AccountId": "The Amazon Web Services account ID of the S3 on Outposts bucket.
", "PutJobTaggingRequest$AccountId": "The Amazon Web Services account ID associated with the S3 Batch Operations job.
", "PutMultiRegionAccessPointPolicyRequest$AccountId": "The Amazon Web Services account ID for the owner of the Multi-Region Access Point.
", "PutPublicAccessBlockRequest$AccountId": "The account ID for the Amazon Web Services account whose PublicAccessBlock configuration you want to set.
Specifies the bucket.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
The Outposts bucket requested.
", "GetBucketTaggingRequest$Bucket": "Specifies the bucket.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
The S3 on Outposts bucket to return the versioning state for.
", "ListAccessPointsRequest$Bucket": "The name of the bucket whose associated access points you want to list.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
The name of the bucket for which to set the configuration.
", "PutBucketPolicyRequest$Bucket": "Specifies the bucket.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
The Amazon Resource Name (ARN) of the bucket.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
The S3 on Outposts bucket to set the versioning state for.
", "Region$Bucket": "The name of the associated bucket for the Region.
", "RegionReport$Bucket": "The name of the bucket.
", "RegionalBucket$Bucket": "" } }, + "BucketVersioningStatus": { + "base": null, + "refs": { + "GetBucketVersioningResult$Status": "The versioning state of the S3 on Outposts bucket.
", + "VersioningConfiguration$Status": "Sets the versioning state of the S3 on Outposts bucket.
" + } + }, "Buckets": { "base": null, "refs": { @@ -753,6 +766,16 @@ "refs": { } }, + "GetBucketVersioningRequest": { + "base": null, + "refs": { + } + }, + "GetBucketVersioningResult": { + "base": null, + "refs": { + } + }, "GetJobTaggingRequest": { "base": null, "refs": { @@ -1142,7 +1165,7 @@ "base": null, "refs": { "S3CopyObjectOperation$SSEAwsKmsKeyId": "", - "SSEKMSEncryption$KeyId": "Specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key to use for encrypting generated manifest objects.
" + "SSEKMSEncryption$KeyId": "Specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric encryption customer managed key to use for encrypting generated manifest objects.
" } }, "LambdaInvokeOperation": { @@ -1260,6 +1283,24 @@ "CreateBucketResult$Location": "The location of the bucket.
" } }, + "MFA": { + "base": null, + "refs": { + "PutBucketVersioningRequest$MFA": "The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.
" + } + }, + "MFADelete": { + "base": null, + "refs": { + "VersioningConfiguration$MFADelete": "Specifies whether MFA delete is enabled or disabled in the bucket versioning configuration for the S3 on Outposts bucket.
" + } + }, + "MFADeleteStatus": { + "base": null, + "refs": { + "GetBucketVersioningResult$MFADelete": "Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is returned only if the bucket has been configured with MFA delete. If MFA delete has never been configured for the bucket, this element is not returned.
" + } + }, "ManifestPrefixString": { "base": null, "refs": { @@ -1270,7 +1311,7 @@ "base": null, "refs": { "AsyncErrorDetails$Code": "A string that uniquely identifies the error condition.
", - "AsyncErrorDetails$Message": "A generic descritpion of the error condition in English.
", + "AsyncErrorDetails$Message": "A generic description of the error condition in English.
", "AsyncErrorDetails$Resource": "The identifier of the resource associated with the error.
", "AsyncErrorDetails$RequestId": "The ID of the request associated with the error.
", "S3UserMetadata$value": null @@ -1352,7 +1393,7 @@ "MultiRegionAccessPointStatus": { "base": null, "refs": { - "MultiRegionAccessPointReport$Status": "The current status of the Multi-Region Access Point.
CREATING and DELETING are temporary states that exist while the request is propogating and being completed. If a Multi-Region Access Point has a status of PARTIALLY_CREATED, you can retry creation or send a request to delete the Multi-Region Access Point. If a Multi-Region Access Point has a status of PARTIALLY_DELETED, you can retry a delete request to finish the deletion of the Multi-Region Access Point.
The current status of the Multi-Region Access Point.
CREATING and DELETING are temporary states that exist while the request is propagating and being completed. If a Multi-Region Access Point has a status of PARTIALLY_CREATED, you can retry creation or send a request to delete the Multi-Region Access Point. If a Multi-Region Access Point has a status of PARTIALLY_DELETED, you can retry a delete request to finish the deletion of the Multi-Region Access Point.
The ID of the Outposts where the bucket is being created.
This is required by Amazon S3 on Outposts buckets.
The ID of the Outposts where the bucket is being created.
This ID is required by Amazon S3 on Outposts buckets.
An idempotency token to ensure that you don't accidentally submit the same request twice. You can use any string up to the maximum length.
", "Endpoints$key": null, - "ListRegionalBucketsRequest$OutpostId": "The ID of the Outposts.
This is required by Amazon S3 on Outposts buckets.
The ID of the Outposts resource.
This ID is required by Amazon S3 on Outposts buckets.
The Outposts ID of the regional bucket.
" } }, @@ -1671,6 +1712,11 @@ "refs": { } }, + "PutBucketVersioningRequest": { + "base": null, + "refs": { + } + }, "PutJobTaggingRequest": { "base": null, "refs": { @@ -2277,6 +2323,12 @@ "refs": { } }, + "VersioningConfiguration": { + "base": "Describes the versioning state of an Amazon S3 on Outposts bucket. For more information, see PutBucketVersioning.
", + "refs": { + "PutBucketVersioningRequest$VersioningConfiguration": "The root-level tag for the VersioningConfiguration parameters.
The virtual private cloud (VPC) configuration for an access point.
", "refs": { diff --git a/models/apis/sagemaker/2017-07-24/api-2.json b/models/apis/sagemaker/2017-07-24/api-2.json index 774cf7b598..7b56f9639b 100644 --- a/models/apis/sagemaker/2017-07-24/api-2.json +++ b/models/apis/sagemaker/2017-07-24/api-2.json @@ -4098,6 +4098,12 @@ "type":"list", "member":{"shape":"AutoMLCandidateStep"} }, + "CanvasAppSettings":{ + "type":"structure", + "members":{ + "TimeSeriesForecastingSettings":{"shape":"TimeSeriesForecastingSettings"} + } + }, "CapacitySize":{ "type":"structure", "required":[ @@ -9090,6 +9096,13 @@ "max":25, "min":0 }, + "FeatureStatus":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, "FeatureType":{ "type":"string", "enum":[ @@ -16141,6 +16154,13 @@ "max":128, "pattern":"[a-zA-Z0-9:_-]+" }, + "TimeSeriesForecastingSettings":{ + "type":"structure", + "members":{ + "Status":{"shape":"FeatureStatus"}, + "AmazonForecastRoleArn":{"shape":"RoleArn"} + } + }, "Timestamp":{"type":"timestamp"}, "TrafficDurationInSeconds":{ "type":"integer", @@ -17404,7 +17424,8 @@ "KernelGatewayAppSettings":{"shape":"KernelGatewayAppSettings"}, "TensorBoardAppSettings":{"shape":"TensorBoardAppSettings"}, "RStudioServerProAppSettings":{"shape":"RStudioServerProAppSettings"}, - "RSessionAppSettings":{"shape":"RSessionAppSettings"} + "RSessionAppSettings":{"shape":"RSessionAppSettings"}, + "CanvasAppSettings":{"shape":"CanvasAppSettings"} } }, "ValidationFraction":{ diff --git a/models/apis/sagemaker/2017-07-24/docs-2.json b/models/apis/sagemaker/2017-07-24/docs-2.json index e3dde8e8db..7deb792011 100644 --- a/models/apis/sagemaker/2017-07-24/docs-2.json +++ b/models/apis/sagemaker/2017-07-24/docs-2.json @@ -51,7 +51,7 @@ "CreateTransformJob": "Starts a transform job. A transform job uses a trained model to get inferences on a dataset and saves these results to an Amazon S3 location that you specify.
To perform batch transformations, you create a transform job and use the data that you have readily available.
In the request body, you provide the following:
TransformJobName - Identifies the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.
ModelName - Identifies the model to use. ModelName must be the name of an existing Amazon SageMaker model in the same Amazon Web Services Region and Amazon Web Services account. For information on creating a model, see CreateModel.
TransformInput - Describes the dataset to be transformed and the Amazon S3 location where it is stored.
TransformOutput - Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
TransformResources - Identifies the ML compute instances for the transform job.
For more information about how batch transformation works, see Batch Transform.
", "CreateTrial": "Creates an SageMaker trial. A trial is a set of steps called trial components that produce a machine learning model. A trial is part of a single SageMaker experiment.
When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.
You can add tags to a trial and then use the Search API to search for the tags.
To get a list of all your trials, call the ListTrials API. To view a trial's properties, call the DescribeTrial API. To create a trial component, call the CreateTrialComponent API.
", "CreateTrialComponent": "Creates a trial component, which is a stage of a machine learning trial. A trial is composed of one or more trial components. A trial component can be used in multiple trials.
Trial components include pre-processing jobs, training jobs, and batch transform jobs.
When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.
You can add tags to a trial component and then use the Search API to search for the tags.
", - "CreateUserProfile": "Creates a user profile. A user profile represents a single user within a domain, and is the main way to reference a \"person\" for the purposes of sharing, reporting, and other user-oriented features. This entity is created when a user onboards to Amazon SageMaker Studio. If an administrator invites a person by email or imports them from Amazon Web Services SSO, a user profile is automatically created. A user profile is the primary holder of settings for an individual user and has a reference to the user's private Amazon Elastic File System (EFS) home directory.
", + "CreateUserProfile": "Creates a user profile. A user profile represents a single user within a domain, and is the main way to reference a \"person\" for the purposes of sharing, reporting, and other user-oriented features. This entity is created when a user onboards to Amazon SageMaker Studio. If an administrator invites a person by email or imports them from IAM Identity Center, a user profile is automatically created. A user profile is the primary holder of settings for an individual user and has a reference to the user's private Amazon Elastic File System (EFS) home directory.
", "CreateWorkforce": "Use this operation to create a workforce. This operation will return an error if a workforce already exists in the Amazon Web Services Region that you specify. You can only create one workforce in each Amazon Web Services Region per Amazon Web Services account.
If you want to create a new workforce in an Amazon Web Services Region where a workforce already exists, use the API operation to delete the existing workforce and then use CreateWorkforce to create a new workforce.
To create a private workforce using Amazon Cognito, you must specify a Cognito user pool in CognitoConfig. You can also create an Amazon Cognito workforce using the Amazon SageMaker console. For more information, see Create a Private Workforce (Amazon Cognito).
To create a private workforce using your own OIDC Identity Provider (IdP), specify your IdP configuration in OidcConfig. Your OIDC IdP must support groups because groups are used by Ground Truth and Amazon A2I to create work teams. For more information, see Create a Private Workforce (OIDC IdP).
Creates a new work team for labeling your data. A work team is defined by one or more Amazon Cognito user pools. You must first create the user pools before you can create a work team.
You cannot create more than 25 work teams in an account and region.
", "DeleteAction": "Deletes an action.
", @@ -64,7 +64,7 @@ "DeleteContext": "Deletes an context.
", "DeleteDataQualityJobDefinition": "Deletes a data quality monitoring job definition.
", "DeleteDeviceFleet": "Deletes a fleet.
", - "DeleteDomain": "Used to delete a domain. If you onboarded with IAM mode, you will need to delete your domain to onboard again using Amazon Web Services SSO. Use with caution. All of the members of the domain will lose access to their EFS volume, including data, notebooks, and other artifacts.
", + "DeleteDomain": "Used to delete a domain. If you onboarded with IAM mode, you will need to delete your domain to onboard again using IAM Identity Center. Use with caution. All of the members of the domain will lose access to their EFS volume, including data, notebooks, and other artifacts.
", "DeleteEdgeDeploymentPlan": "Deletes an edge deployment plan if (and only if) all the stages in the plan are inactive or there are no stages in the plan.
", "DeleteEdgeDeploymentStage": "Delete a stage in an edge deployment plan if (and only if) the stage is inactive.
", "DeleteEndpoint": "Deletes an endpoint. SageMaker frees up all of the resources that were deployed when the endpoint was created.
SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't need to use the RevokeGrant API call.
When you delete your endpoint, SageMaker asynchronously deletes associated endpoint resources such as KMS key grants. You might still see these resources in your account for a few minutes after deleting your endpoint. Do not delete or revoke the permissions for your ExecutionRoleArn , otherwise SageMaker cannot delete these resources.
Information about the candidate's steps.
" } }, + "CanvasAppSettings": { + "base": "The SageMaker Canvas app settings.
", + "refs": { + "UserSettings$CanvasAppSettings": "The Canvas app settings.
" + } + }, "CapacitySize": { "base": "Specifies the endpoint capacity to activate for production.
", "refs": { @@ -4682,6 +4688,12 @@ "FeatureMetadata$Parameters": "Optional key-value pairs that you specify to better describe the feature.
" } }, + "FeatureStatus": { + "base": null, + "refs": { + "TimeSeriesForecastingSettings$Status": "Describes whether time series forecasting is enabled or disabled in the Canvas app.
" + } + }, "FeatureType": { "base": null, "refs": { @@ -5192,7 +5204,7 @@ } }, "HyperParameterTuningJobSearchEntity": { - "base": "An entity having characteristics over which a user can search for a hyperparameter tuning job.
", + "base": "An entity returned by the SearchRecord API containing the properties of a hyperparameter tuning job.
", "refs": { "SearchRecord$HyperParameterTuningJob": "The properties of a hyperparameter tuning job.
" } @@ -9853,6 +9865,7 @@ "RStudioServerProDomainSettingsForUpdate$DomainExecutionRoleArn": "The execution role for the RStudioServerPro Domain-level app.
The IAM role attached to your Redshift cluster that Amazon SageMaker uses to generate datasets.
", "RenderUiTemplateRequest$RoleArn": "The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the template.
", + "TimeSeriesForecastingSettings$AmazonForecastRoleArn": "The IAM role that Canvas passes to Amazon Forecast for time series forecasting. By default, Canvas uses the execution role specified in the UserProfile that launches the Canvas app. If an execution role is not specified in the UserProfile, Canvas uses the execution role specified in the Domain that owns the UserProfile. To allow time series forecasting, this IAM role should have the AmazonSageMakerCanvasForecastAccess policy attached and forecast.amazonaws.com added in the trust relationship as a service principal.
The Amazon Web Services Identity and Access Management (IAM) role configured for the training job.
", "UpdateDeviceFleetRequest$RoleArn": "The Amazon Resource Name (ARN) of the device.
", "UpdateImageRequest$RoleArn": "The new Amazon Resource Name (ARN) for the IAM role that enables Amazon SageMaker to perform tasks on your behalf.
", @@ -9921,7 +9934,7 @@ "base": null, "refs": { "AthenaDatasetDefinition$OutputS3Uri": "The location in Amazon S3 where Athena query results are stored.
", - "AutoMLCandidateGenerationConfig$FeatureSpecificationS3Uri": "A URL to the Amazon S3 data source containing selected features from the input data source to run an Autopilot job (optional). This file should be in json format as shown below:
{ \"FeatureAttributeNames\":[\"col1\", \"col2\", ...] }.
The key name FeatureAttributeNames is fixed. The values listed in [\"col1\", \"col2\", ...] is case sensitive and should be a list of strings containing unique values that are a subset of the column names in the input data. The list of columns provided must not include the target column.
A URL to the Amazon S3 data source containing selected features from the input data source to run an Autopilot job. You can input FeatureAttributeNames (optional) in JSON format as shown below:
{ \"FeatureAttributeNames\":[\"col1\", \"col2\", ...] }.
You can also specify the data type of the feature (optional) in the format shown below:
{ \"FeatureDataTypes\":{\"col1\":\"numeric\", \"col2\":\"categorical\" ... } }
These column keys may not include the target column.
In ensembling mode, Autopilot will only support the following data types: numeric, categorical, text and datetime. In HPO mode, Autopilot can support numeric, categorical, text, datetime and sequence.
If only FeatureDataTypes is provided, the column keys (col1, col2,..) should be a subset of the column names in the input data.
If both FeatureDataTypes and FeatureAttributeNames are provided, then the column keys should be a subset of the column names provided in FeatureAttributeNames.
The key name FeatureAttributeNames is fixed. The values listed in [\"col1\", \"col2\", ...] is case sensitive and should be a list of strings containing unique values that are a subset of the column names in the input data. The list of columns provided must not include the target column.
The Amazon S3 output path. Must be 128 characters or less.
", "AutoMLS3DataSource$S3Uri": "The URL to the Amazon S3 data source.
", "CheckpointConfig$S3Uri": "Identifies the S3 path where you want SageMaker to store checkpoints. For example, s3://bucket-name/key-name-prefix.
A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is \"UserName\". If the Domain's AuthMode is Amazon Web Services SSO, this field is required. If the Domain's AuthMode is not Amazon Web Services SSO, this field cannot be specified.
", - "DescribeUserProfileResponse$SingleSignOnUserIdentifier": "The Amazon Web Services SSO user identifier.
" + "CreateUserProfileRequest$SingleSignOnUserIdentifier": "A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is \"UserName\". If the Domain's AuthMode is IAM Identity Center, this field is required. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.
", + "DescribeUserProfileResponse$SingleSignOnUserIdentifier": "The IAM Identity Center user identifier.
" } }, "SnsTopicArn": { @@ -10637,12 +10650,12 @@ "CreateActionRequest$ActionType": "The action type.
", "CreateArtifactRequest$ArtifactType": "The artifact type.
", "CreateContextRequest$ContextType": "The context type.
", - "CreateUserProfileRequest$SingleSignOnUserValue": "The username of the associated Amazon Web Services Single Sign-On User for this UserProfile. If the Domain's AuthMode is Amazon Web Services SSO, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not Amazon Web Services SSO, this field cannot be specified.
", + "CreateUserProfileRequest$SingleSignOnUserValue": "The username of the associated Amazon Web Services Single Sign-On User for this UserProfile. If the Domain's AuthMode is IAM Identity Center, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.
", "DescribeActionResponse$ActionType": "The type of the action.
", "DescribeArtifactResponse$ArtifactType": "The type of the artifact.
", "DescribeContextResponse$ContextType": "The type of the context.
", - "DescribeDomainResponse$SingleSignOnManagedApplicationInstanceId": "The Amazon Web Services SSO managed application instance ID.
", - "DescribeUserProfileResponse$SingleSignOnUserValue": "The Amazon Web Services SSO user value.
", + "DescribeDomainResponse$SingleSignOnManagedApplicationInstanceId": "The IAM Identity Center managed application instance ID.
", + "DescribeUserProfileResponse$SingleSignOnUserValue": "The IAM Identity Center user value.
", "EMRStepMetadata$ClusterId": "The identifier of the EMR cluster.
", "EMRStepMetadata$StepId": "The identifier of the EMR cluster step.
", "EMRStepMetadata$StepName": "The name of the EMR cluster step.
", @@ -11048,6 +11061,12 @@ "DeviceSummary$IotThingName": "The Amazon Web Services Internet of Things (IoT) object thing name associated with the device..
" } }, + "TimeSeriesForecastingSettings": { + "base": "Time series forecast settings for the SageMaker Canvas app.
", + "refs": { + "CanvasAppSettings$TimeSeriesForecastingSettings": "Time series forecast settings for the Canvas app.
" + } + }, "Timestamp": { "base": null, "refs": { diff --git a/models/endpoints/endpoints.json b/models/endpoints/endpoints.json index 6eb0c9ab10..d2f3470a8f 100644 --- a/models/endpoints/endpoints.json +++ b/models/endpoints/endpoints.json @@ -4151,6 +4151,7 @@ "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-3" : { }, "ca-central-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, @@ -5476,6 +5477,8 @@ "emr-serverless" : { "endpoints" : { "ap-northeast-1" : { }, + "ap-southeast-1" : { }, + "eu-central-1" : { }, "eu-west-1" : { }, "fips-us-east-1" : { "credentialScope" : { @@ -5484,6 +5487,13 @@ "deprecated" : true, "hostname" : "emr-serverless-fips.us-east-1.amazonaws.com" }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "hostname" : "emr-serverless-fips.us-east-2.amazonaws.com" + }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" @@ -5497,6 +5507,12 @@ "tags" : [ "fips" ] } ] }, + "us-east-2" : { + "variants" : [ { + "hostname" : "emr-serverless-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-west-2" : { "variants" : [ { "hostname" : "emr-serverless-fips.us-west-2.amazonaws.com", @@ -10247,6 +10263,7 @@ "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-3" : { }, "ca-central-1" : { "variants" : [ { "hostname" : "rbin-fips.ca-central-1.amazonaws.com", diff --git a/service/comprehend/api.go b/service/comprehend/api.go index 71be7d9b29..5b759bb2c5 100644 --- a/service/comprehend/api.go +++ b/service/comprehend/api.go @@ -148,7 +148,9 @@ func (c *Comprehend) BatchDetectEntitiesRequest(input *BatchDetectEntitiesInput) // BatchDetectEntities API operation for Amazon Comprehend. // // Inspects the text of a batch of documents for named entities and returns -// information about them. For more information about named entities, see how-entities +// information about them. For more information about named entities, see Entities +// (https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.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 @@ -168,7 +170,9 @@ func (c *Comprehend) BatchDetectEntitiesRequest(input *BatchDetectEntitiesInput) // - UnsupportedLanguageException // Amazon Comprehend can't process the language of the input text. For custom // entity recognition APIs, only English, Spanish, French, Italian, German, -// or Portuguese are accepted. For a list of supported languages, see supported-languages. +// or Portuguese are accepted. For a list of supported languages, Supported +// languages (https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html) +// in the Comprehend Developer Guide. // // - BatchSizeLimitExceededException // The number of documents in the request exceeds the limit of 25. Try your @@ -262,7 +266,9 @@ func (c *Comprehend) BatchDetectKeyPhrasesRequest(input *BatchDetectKeyPhrasesIn // - UnsupportedLanguageException // Amazon Comprehend can't process the language of the input text. For custom // entity recognition APIs, only English, Spanish, French, Italian, German, -// or Portuguese are accepted. For a list of supported languages, see supported-languages. +// or Portuguese are accepted. For a list of supported languages, Supported +// languages (https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html) +// in the Comprehend Developer Guide. // // - BatchSizeLimitExceededException // The number of documents in the request exceeds the limit of 25. Try your @@ -357,7 +363,9 @@ func (c *Comprehend) BatchDetectSentimentRequest(input *BatchDetectSentimentInpu // - UnsupportedLanguageException // Amazon Comprehend can't process the language of the input text. For custom // entity recognition APIs, only English, Spanish, French, Italian, German, -// or Portuguese are accepted. For a list of supported languages, see supported-languages. +// or Portuguese are accepted. For a list of supported languages, Supported +// languages (https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html) +// in the Comprehend Developer Guide. // // - BatchSizeLimitExceededException // The number of documents in the request exceeds the limit of 25. Try your @@ -433,7 +441,8 @@ func (c *Comprehend) BatchDetectSyntaxRequest(input *BatchDetectSyntaxInput) (re // // 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 how-syntax. +// information, see Syntax (https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.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 @@ -453,7 +462,9 @@ func (c *Comprehend) BatchDetectSyntaxRequest(input *BatchDetectSyntaxInput) (re // - UnsupportedLanguageException // Amazon Comprehend can't process the language of the input text. For custom // entity recognition APIs, only English, Spanish, French, Italian, German, -// or Portuguese are accepted. For a list of supported languages, see supported-languages. +// or Portuguese are accepted. For a list of supported languages, Supported +// languages (https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html) +// in the Comprehend Developer Guide. // // - BatchSizeLimitExceededException // The number of documents in the request exceeds the limit of 25. Try your @@ -484,6 +495,105 @@ func (c *Comprehend) BatchDetectSyntaxWithContext(ctx aws.Context, input *BatchD return out, req.Send() } +const opBatchDetectTargetedSentiment = "BatchDetectTargetedSentiment" + +// BatchDetectTargetedSentimentRequest generates a "aws/request.Request" representing the +// client's request for the BatchDetectTargetedSentiment 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 BatchDetectTargetedSentiment for more information on using the BatchDetectTargetedSentiment +// 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 BatchDetectTargetedSentimentRequest method. +// req, resp := client.BatchDetectTargetedSentimentRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectTargetedSentiment +func (c *Comprehend) BatchDetectTargetedSentimentRequest(input *BatchDetectTargetedSentimentInput) (req *request.Request, output *BatchDetectTargetedSentimentOutput) { + op := &request.Operation{ + Name: opBatchDetectTargetedSentiment, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &BatchDetectTargetedSentimentInput{} + } + + output = &BatchDetectTargetedSentimentOutput{} + req = c.newRequest(op, input, output) + return +} + +// BatchDetectTargetedSentiment API operation for Amazon Comprehend. +// +// 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 (https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.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 Comprehend's +// API operation BatchDetectTargetedSentiment for usage and error information. +// +// Returned Error Types: +// +// - InvalidRequestException +// The request is invalid. +// +// - TextSizeLimitExceededException +// The size of the input text exceeds the limit. Use a smaller document. +// +// - UnsupportedLanguageException +// Amazon Comprehend can't process the language of the input text. For custom +// entity recognition APIs, only English, Spanish, French, Italian, German, +// or Portuguese are accepted. For a list of supported languages, Supported +// languages (https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html) +// in the Comprehend Developer Guide. +// +// - BatchSizeLimitExceededException +// The number of documents in the request exceeds the limit of 25. Try your +// request again with fewer documents. +// +// - InternalServerException +// An internal server error occurred. Retry your request. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectTargetedSentiment +func (c *Comprehend) BatchDetectTargetedSentiment(input *BatchDetectTargetedSentimentInput) (*BatchDetectTargetedSentimentOutput, error) { + req, out := c.BatchDetectTargetedSentimentRequest(input) + return out, req.Send() +} + +// BatchDetectTargetedSentimentWithContext is the same as BatchDetectTargetedSentiment with the addition of +// the ability to pass a context and additional request options. +// +// See BatchDetectTargetedSentiment 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 *Comprehend) BatchDetectTargetedSentimentWithContext(ctx aws.Context, input *BatchDetectTargetedSentimentInput, opts ...request.Option) (*BatchDetectTargetedSentimentOutput, error) { + req, out := c.BatchDetectTargetedSentimentRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opClassifyDocument = "ClassifyDocument" // ClassifyDocumentRequest generates a "aws/request.Request" representing the @@ -640,7 +750,9 @@ func (c *Comprehend) ContainsPiiEntitiesRequest(input *ContainsPiiEntitiesInput) // - UnsupportedLanguageException // Amazon Comprehend can't process the language of the input text. For custom // entity recognition APIs, only English, Spanish, French, Italian, German, -// or Portuguese are accepted. For a list of supported languages, see supported-languages. +// or Portuguese are accepted. For a list of supported languages, Supported +// languages (https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html) +// in the Comprehend Developer Guide. // // - InternalServerException // An internal server error occurred. Retry your request. @@ -714,7 +826,8 @@ func (c *Comprehend) CreateDocumentClassifierRequest(input *CreateDocumentClassi // 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 how-document-classification. +// For more information, see Document Classification (https://docs.aws.amazon.com/comprehend/latest/dg/how-document-classification.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 @@ -747,7 +860,9 @@ func (c *Comprehend) CreateDocumentClassifierRequest(input *CreateDocumentClassi // - UnsupportedLanguageException // Amazon Comprehend can't process the language of the input text. For custom // entity recognition APIs, only English, Spanish, French, Italian, German, -// or Portuguese are accepted. For a list of supported languages, see supported-languages. +// or Portuguese are accepted. For a list of supported languages, Supported +// languages (https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html) +// in the Comprehend Developer Guide. // // - KmsKeyValidationException // The KMS customer managed key (CMK) entered cannot be validated. Verify the @@ -963,7 +1078,9 @@ func (c *Comprehend) CreateEntityRecognizerRequest(input *CreateEntityRecognizer // - UnsupportedLanguageException // Amazon Comprehend can't process the language of the input text. For custom // entity recognition APIs, only English, Spanish, French, Italian, German, -// or Portuguese are accepted. For a list of supported languages, see supported-languages. +// or Portuguese are accepted. For a list of supported languages, Supported +// languages (https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html) +// in the Comprehend Developer Guide. // // - KmsKeyValidationException // The KMS customer managed key (CMK) entered cannot be validated. Verify the @@ -2677,7 +2794,8 @@ 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 how-entities. +// more information, about named entities, see Entities (https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.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 @@ -2701,7 +2819,9 @@ func (c *Comprehend) DetectEntitiesRequest(input *DetectEntitiesInput) (req *req // - UnsupportedLanguageException // Amazon Comprehend can't process the language of the input text. For custom // entity recognition APIs, only English, Spanish, French, Italian, German, -// or Portuguese are accepted. For a list of supported languages, see supported-languages. +// or Portuguese are accepted. For a list of supported languages, Supported +// languages (https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html) +// in the Comprehend Developer Guide. // // - InternalServerException // An internal server error occurred. Retry your request. @@ -2791,7 +2911,9 @@ func (c *Comprehend) DetectKeyPhrasesRequest(input *DetectKeyPhrasesInput) (req // - UnsupportedLanguageException // Amazon Comprehend can't process the language of the input text. For custom // entity recognition APIs, only English, Spanish, French, Italian, German, -// or Portuguese are accepted. For a list of supported languages, see supported-languages. +// or Portuguese are accepted. For a list of supported languages, Supported +// languages (https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html) +// in the Comprehend Developer Guide. // // - InternalServerException // An internal server error occurred. Retry your request. @@ -2882,7 +3004,9 @@ func (c *Comprehend) DetectPiiEntitiesRequest(input *DetectPiiEntitiesInput) (re // - UnsupportedLanguageException // Amazon Comprehend can't process the language of the input text. For custom // entity recognition APIs, only English, Spanish, French, Italian, German, -// or Portuguese are accepted. For a list of supported languages, see supported-languages. +// or Portuguese are accepted. For a list of supported languages, Supported +// languages (https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html) +// in the Comprehend Developer Guide. // // - InternalServerException // An internal server error occurred. Retry your request. @@ -2973,7 +3097,9 @@ func (c *Comprehend) DetectSentimentRequest(input *DetectSentimentInput) (req *r // - UnsupportedLanguageException // Amazon Comprehend can't process the language of the input text. For custom // entity recognition APIs, only English, Spanish, French, Italian, German, -// or Portuguese are accepted. For a list of supported languages, see supported-languages. +// or Portuguese are accepted. For a list of supported languages, Supported +// languages (https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html) +// in the Comprehend Developer Guide. // // - InternalServerException // An internal server error occurred. Retry your request. @@ -3044,7 +3170,8 @@ func (c *Comprehend) DetectSyntaxRequest(input *DetectSyntaxInput) (req *request // DetectSyntax API operation for Amazon Comprehend. // // Inspects text for syntax and the part of speech of words in the document. -// For more information, how-syntax. +// For more information, see Syntax (https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.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 @@ -3064,7 +3191,9 @@ func (c *Comprehend) DetectSyntaxRequest(input *DetectSyntaxInput) (req *request // - UnsupportedLanguageException // Amazon Comprehend can't process the language of the input text. For custom // entity recognition APIs, only English, Spanish, French, Italian, German, -// or Portuguese are accepted. For a list of supported languages, see supported-languages. +// or Portuguese are accepted. For a list of supported languages, Supported +// languages (https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html) +// in the Comprehend Developer Guide. // // - InternalServerException // An internal server error occurred. Retry your request. @@ -3091,6 +3220,101 @@ func (c *Comprehend) DetectSyntaxWithContext(ctx aws.Context, input *DetectSynta return out, req.Send() } +const opDetectTargetedSentiment = "DetectTargetedSentiment" + +// DetectTargetedSentimentRequest generates a "aws/request.Request" representing the +// client's request for the DetectTargetedSentiment 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 DetectTargetedSentiment for more information on using the DetectTargetedSentiment +// 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 DetectTargetedSentimentRequest method. +// req, resp := client.DetectTargetedSentimentRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectTargetedSentiment +func (c *Comprehend) DetectTargetedSentimentRequest(input *DetectTargetedSentimentInput) (req *request.Request, output *DetectTargetedSentimentOutput) { + op := &request.Operation{ + Name: opDetectTargetedSentiment, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DetectTargetedSentimentInput{} + } + + output = &DetectTargetedSentimentOutput{} + req = c.newRequest(op, input, output) + return +} + +// DetectTargetedSentiment API operation for Amazon Comprehend. +// +// Inspects the input text and returns a sentiment analysis for each entity +// identified in the text. +// +// For more information about targeted sentiment, see Targeted sentiment (https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.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 Comprehend's +// API operation DetectTargetedSentiment for usage and error information. +// +// Returned Error Types: +// +// - InvalidRequestException +// The request is invalid. +// +// - TextSizeLimitExceededException +// The size of the input text exceeds the limit. Use a smaller document. +// +// - UnsupportedLanguageException +// Amazon Comprehend can't process the language of the input text. For custom +// entity recognition APIs, only English, Spanish, French, Italian, German, +// or Portuguese are accepted. For a list of supported languages, Supported +// languages (https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html) +// in the Comprehend Developer Guide. +// +// - InternalServerException +// An internal server error occurred. Retry your request. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectTargetedSentiment +func (c *Comprehend) DetectTargetedSentiment(input *DetectTargetedSentimentInput) (*DetectTargetedSentimentOutput, error) { + req, out := c.DetectTargetedSentimentRequest(input) + return out, req.Send() +} + +// DetectTargetedSentimentWithContext is the same as DetectTargetedSentiment with the addition of +// the ability to pass a context and additional request options. +// +// See DetectTargetedSentiment 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 *Comprehend) DetectTargetedSentimentWithContext(ctx aws.Context, input *DetectTargetedSentimentInput, opts ...request.Option) (*DetectTargetedSentimentOutput, error) { + req, out := c.DetectTargetedSentimentRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opImportModel = "ImportModel" // ImportModelRequest generates a "aws/request.Request" representing the @@ -7439,9 +7663,9 @@ func (s *AugmentedManifestsListItem) SetSplit(v string) *AugmentedManifestsListI type BatchDetectDominantLanguageInput struct { _ struct{} `type:"structure"` - // A list containing the text of the input documents. The list can contain a - // maximum of 25 documents. Each document should contain at least 20 characters - // and must contain fewer than 5,000 bytes of UTF-8 encoded characters. + // A list containing the UTF-8 encoded text of the input documents. The list + // can contain a maximum of 25 documents. Each document should contain at least + // 20 characters. The maximum size of each document is 5 KB. // // TextList is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by BatchDetectDominantLanguageInput's @@ -7593,9 +7817,9 @@ type BatchDetectEntitiesInput struct { // LanguageCode is a required field LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` - // A list containing the text of the input documents. The list can contain a - // maximum of 25 documents. Each document must contain fewer than 5,000 bytes - // of UTF-8 encoded characters. + // A list containing the UTF-8 encoded text of the input documents. The list + // can contain a maximum of 25 documents. The maximum size of each document + // is 5 KB. // // TextList is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by BatchDetectEntitiesInput's @@ -7755,9 +7979,9 @@ type BatchDetectKeyPhrasesInput struct { // LanguageCode is a required field LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` - // A list containing the text of the input documents. The list can contain a - // maximum of 25 documents. Each document must contain fewer than 5,000 bytes - // of UTF-8 encoded characters. + // A list containing the UTF-8 encoded text of the input documents. The list + // can contain a maximum of 25 documents. The maximum size of each document + // is 5 KB. // // TextList is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by BatchDetectKeyPhrasesInput's @@ -7917,9 +8141,12 @@ type BatchDetectSentimentInput struct { // LanguageCode is a required field LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` - // A list containing the text of the input documents. The list can contain a - // maximum of 25 documents. Each document must contain fewer that 5,000 bytes - // of UTF-8 encoded characters. + // A list containing the UTF-8 encoded text of the input documents. The list + // can contain a maximum of 25 documents. The maximum size of each document + // 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. // // TextList is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by BatchDetectSentimentInput's @@ -8091,9 +8318,9 @@ type BatchDetectSyntaxInput struct { // LanguageCode is a required field LanguageCode *string `type:"string" required:"true" enum:"SyntaxLanguageCode"` - // A list containing the text of the input documents. The list can contain a - // maximum of 25 documents. Each document must contain fewer that 5,000 bytes - // of UTF-8 encoded characters. + // A list containing the UTF-8 encoded text of the input documents. The list + // can contain a maximum of 25 documents. The maximum size for each document + // is 5 KB. // // TextList is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by BatchDetectSyntaxInput's @@ -8211,7 +8438,165 @@ type BatchDetectSyntaxOutput struct { // is empty. // // ResultList is a required field - ResultList []*BatchDetectSyntaxItemResult `type:"list" required:"true"` + ResultList []*BatchDetectSyntaxItemResult `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 BatchDetectSyntaxOutput) 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 BatchDetectSyntaxOutput) GoString() string { + return s.String() +} + +// SetErrorList sets the ErrorList field's value. +func (s *BatchDetectSyntaxOutput) SetErrorList(v []*BatchItemError) *BatchDetectSyntaxOutput { + s.ErrorList = v + return s +} + +// SetResultList sets the ResultList field's value. +func (s *BatchDetectSyntaxOutput) SetResultList(v []*BatchDetectSyntaxItemResult) *BatchDetectSyntaxOutput { + s.ResultList = v + return s +} + +type BatchDetectTargetedSentimentInput struct { + _ struct{} `type:"structure"` + + // The language of the input documents. Currently, English is the only supported + // language. + // + // LanguageCode is a required field + LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` + + // A list containing the UTF-8 encoded text of the input documents. The list + // can contain a maximum of 25 documents. The maximum size of each document + // is 5 KB. + // + // TextList is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by BatchDetectTargetedSentimentInput's + // String and GoString methods. + // + // TextList is a required field + TextList []*string `min:"1" type:"list" 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 BatchDetectTargetedSentimentInput) 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 BatchDetectTargetedSentimentInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *BatchDetectTargetedSentimentInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "BatchDetectTargetedSentimentInput"} + if s.LanguageCode == nil { + invalidParams.Add(request.NewErrParamRequired("LanguageCode")) + } + if s.TextList == nil { + invalidParams.Add(request.NewErrParamRequired("TextList")) + } + if s.TextList != nil && len(s.TextList) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TextList", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetLanguageCode sets the LanguageCode field's value. +func (s *BatchDetectTargetedSentimentInput) SetLanguageCode(v string) *BatchDetectTargetedSentimentInput { + s.LanguageCode = &v + return s +} + +// SetTextList sets the TextList field's value. +func (s *BatchDetectTargetedSentimentInput) SetTextList(v []*string) *BatchDetectTargetedSentimentInput { + s.TextList = v + return s +} + +// Analysis results for one of the documents in the batch. +type BatchDetectTargetedSentimentItemResult struct { + _ struct{} `type:"structure"` + + // An array of targeted sentiment entities. + Entities []*TargetedSentimentEntity `type:"list"` + + // The zero-based index of this result in the input list. + Index *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 BatchDetectTargetedSentimentItemResult) 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 BatchDetectTargetedSentimentItemResult) GoString() string { + return s.String() +} + +// SetEntities sets the Entities field's value. +func (s *BatchDetectTargetedSentimentItemResult) SetEntities(v []*TargetedSentimentEntity) *BatchDetectTargetedSentimentItemResult { + s.Entities = v + return s +} + +// SetIndex sets the Index field's value. +func (s *BatchDetectTargetedSentimentItemResult) SetIndex(v int64) *BatchDetectTargetedSentimentItemResult { + s.Index = &v + return s +} + +type BatchDetectTargetedSentimentOutput struct { + _ struct{} `type:"structure" sensitive:"true"` + + // List of errors that the operation can return. + // + // ErrorList is a required field + ErrorList []*BatchItemError `type:"list" required:"true"` + + // A list of objects containing the results of the operation. The results are + // sorted in ascending order by the Index field and match the order of the documents + // in the input list. If all of the documents contain an error, the ResultList + // is empty. + // + // ResultList is a required field + ResultList []*BatchDetectTargetedSentimentItemResult `type:"list" required:"true"` } // String returns the string representation. @@ -8219,7 +8604,7 @@ type BatchDetectSyntaxOutput 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 BatchDetectSyntaxOutput) String() string { +func (s BatchDetectTargetedSentimentOutput) String() string { return awsutil.Prettify(s) } @@ -8228,18 +8613,18 @@ func (s BatchDetectSyntaxOutput) 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 BatchDetectSyntaxOutput) GoString() string { +func (s BatchDetectTargetedSentimentOutput) GoString() string { return s.String() } // SetErrorList sets the ErrorList field's value. -func (s *BatchDetectSyntaxOutput) SetErrorList(v []*BatchItemError) *BatchDetectSyntaxOutput { +func (s *BatchDetectTargetedSentimentOutput) SetErrorList(v []*BatchItemError) *BatchDetectTargetedSentimentOutput { s.ErrorList = v return s } // SetResultList sets the ResultList field's value. -func (s *BatchDetectSyntaxOutput) SetResultList(v []*BatchDetectSyntaxItemResult) *BatchDetectSyntaxOutput { +func (s *BatchDetectTargetedSentimentOutput) SetResultList(v []*BatchDetectTargetedSentimentItemResult) *BatchDetectTargetedSentimentOutput { s.ResultList = v return s } @@ -8730,9 +9115,7 @@ type ContainsPiiEntitiesInput struct { // LanguageCode is a required field LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` - // Creates a new document classification request to analyze a single document - // in real-time, returning personally identifiable information (PII) entity - // labels. + // A UTF-8 text string. The maximum string size is 100 KB. // // Text is a required field Text *string `min:"1" type:"string" required:"true"` @@ -10864,8 +11247,8 @@ func (s *DescribeTopicsDetectionJobOutput) SetTopicsDetectionJobProperties(v *To type DetectDominantLanguageInput struct { _ struct{} `type:"structure"` - // A UTF-8 text string. Each string should contain at least 20 characters and - // must contain fewer that 5,000 bytes of UTF-8 encoded characters. + // A UTF-8 text string. The string must contain at least 20 characters. The + // maximum string size is 100 KB. // // Text is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by DetectDominantLanguageInput's @@ -10972,8 +11355,7 @@ type DetectEntitiesInput struct { // any language code that you specify here. LanguageCode *string `type:"string" enum:"LanguageCode"` - // A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 - // encoded characters. + // A UTF-8 text string. The maximum string size is 100 KB. // // Text is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by DetectEntitiesInput's @@ -11045,7 +11427,8 @@ type DetectEntitiesOutput struct { // If your request uses a custom entity recognition model, Amazon Comprehend // detects the entities that the model is trained to recognize. Otherwise, it // detects the default entity types. For a list of default entity types, see - // how-entities. + // Entities (https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html) + // in the Comprehend Developer Guide. Entities []*Entity `type:"list"` } @@ -11082,8 +11465,8 @@ type DetectKeyPhrasesInput struct { // LanguageCode is a required field LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` - // A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 - // encoded characters. + // A UTF-8 text string. The string must contain less than 100 KB of UTF-8 encoded + // characters. // // Text is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by DetectKeyPhrasesInput's @@ -11185,8 +11568,7 @@ type DetectPiiEntitiesInput struct { // LanguageCode is a required field LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` - // A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 - // encoded characters. + // A UTF-8 text string. The maximum string size is 100 KB. // // Text is a required field Text *string `min:"1" type:"string" required:"true"` @@ -11283,8 +11665,10 @@ type DetectSentimentInput struct { // LanguageCode is a required field LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` - // A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 - // encoded characters. + // 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. // // Text is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by DetectSentimentInput's @@ -11394,8 +11778,7 @@ type DetectSyntaxInput struct { // LanguageCode is a required field LanguageCode *string `type:"string" required:"true" enum:"SyntaxLanguageCode"` - // A UTF-8 string. Each string must contain fewer that 5,000 bytes of UTF encoded - // characters. + // A UTF-8 string. The maximum string size is 5 KB. // // Text is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by DetectSyntaxInput's @@ -11460,7 +11843,8 @@ type DetectSyntaxOutput struct { // A collection of syntax tokens describing the text. For each token, the response // provides the text, the token type, where the text begins and ends, and the // level of confidence that Amazon Comprehend has that the token is correct. - // For a list of token types, see how-syntax. + // For a list of token types, see Syntax (https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html) + // in the Comprehend Developer Guide. SyntaxTokens []*SyntaxToken `type:"list"` } @@ -11488,6 +11872,106 @@ func (s *DetectSyntaxOutput) SetSyntaxTokens(v []*SyntaxToken) *DetectSyntaxOutp return s } +type DetectTargetedSentimentInput struct { + _ struct{} `type:"structure"` + + // The language of the input documents. Currently, English is the only supported + // language. + // + // LanguageCode is a required field + LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` + + // A UTF-8 text string. The maximum string length is 5 KB. + // + // Text is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by DetectTargetedSentimentInput's + // String and GoString methods. + // + // Text is a required field + Text *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 DetectTargetedSentimentInput) 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 DetectTargetedSentimentInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DetectTargetedSentimentInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DetectTargetedSentimentInput"} + if s.LanguageCode == nil { + invalidParams.Add(request.NewErrParamRequired("LanguageCode")) + } + if s.Text == nil { + invalidParams.Add(request.NewErrParamRequired("Text")) + } + if s.Text != nil && len(*s.Text) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Text", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetLanguageCode sets the LanguageCode field's value. +func (s *DetectTargetedSentimentInput) SetLanguageCode(v string) *DetectTargetedSentimentInput { + s.LanguageCode = &v + return s +} + +// SetText sets the Text field's value. +func (s *DetectTargetedSentimentInput) SetText(v string) *DetectTargetedSentimentInput { + s.Text = &v + return s +} + +type DetectTargetedSentimentOutput struct { + _ struct{} `type:"structure" sensitive:"true"` + + // Targeted sentiment analysis for each of the entities identified in the input + // text. + Entities []*TargetedSentimentEntity `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 DetectTargetedSentimentOutput) 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 DetectTargetedSentimentOutput) GoString() string { + return s.String() +} + +// SetEntities sets the Entities field's value. +func (s *DetectTargetedSentimentOutput) SetEntities(v []*TargetedSentimentEntity) *DetectTargetedSentimentOutput { + s.Entities = v + return s +} + // Specifies the class that categorizes the document being analyzed type DocumentClass struct { _ struct{} `type:"structure"` @@ -11836,7 +12320,9 @@ func (s *DocumentClassifierFilter) SetSubmitTimeBefore(v time.Time) *DocumentCla // The input properties for training a document classifier. // -// For more information on how the input file is formatted, see prep-classifier-data. +// For more information on how the input file is formatted, see Preparing training +// data (https://docs.aws.amazon.com/comprehend/latest/dg/prep-classifier-data.html) +// in the Comprehend Developer Guide. type DocumentClassifierInputDataConfig struct { _ struct{} `type:"structure"` @@ -11882,10 +12368,9 @@ type DocumentClassifierInputDataConfig struct { // This parameter is required if you set DataFormat to COMPREHEND_CSV. S3Uri *string `type:"string"` - // The Amazon S3 URI for the input data. The Amazon S3 bucket must be in the - // same AWS Region as the API endpoint that you are calling. The URI can point - // to a single input file or it can provide the prefix for a collection of input - // files. + // This specifies the Amazon S3 location where the test annotations for an entity + // recognizer are located. The URI must be in the same AWS Region as the API + // endpoint that you are calling. TestS3Uri *string `type:"string"` } @@ -13148,17 +13633,12 @@ func (s *EntitiesDetectionJobProperties) SetVpcConfig(v *VpcConfig) *EntitiesDet type Entity struct { _ struct{} `type:"structure"` - // A character offset in the input text that shows where the entity begins (the - // first character is at position 0). The offset returns the position of each - // UTF-8 code point in the string. A code point is the abstract character from - // a particular graphical representation. For example, a multi-byte UTF-8 character - // maps to a single code point. + // The zero-based offset from the beginning of the source text to the first + // character in the entity. BeginOffset *int64 `type:"integer"` - // A character offset in the input text that shows where the entity ends. The - // offset returns the position of each UTF-8 code point in the string. A code - // point is the abstract character from a particular graphical representation. - // For example, a multi-byte UTF-8 character maps to a single code point. + // The zero-based offset from the beginning of the source text to the last character + // in the entity. EndOffset *int64 `type:"integer"` // The level of confidence that Amazon Comprehend has in the accuracy of the @@ -13274,9 +13754,9 @@ type EntityRecognizerAnnotations struct { // S3Uri is a required field S3Uri *string `type:"string" required:"true"` - // This specifies the Amazon S3 location where the test annotations for an entity - // recognizer are located. The URI must be in the same AWS Region as the API - // endpoint that you are calling. + // Specifies the Amazon S3 location where the test annotations for an entity + // recognizer are located. The URI must be in the same region as the API endpoint + // that you are calling. TestS3Uri *string `type:"string"` } @@ -14927,17 +15407,12 @@ func (s *JobNotFoundException) RequestID() string { type KeyPhrase struct { _ struct{} `type:"structure"` - // A character offset in the input text that shows where the key phrase begins - // (the first character is at position 0). The offset returns the position of - // each UTF-8 code point in the string. A code point is the abstract character - // from a particular graphical representation. For example, a multi-byte UTF-8 - // character maps to a single code point. + // The zero-based offset from the beginning of the source text to the first + // character in the key phrase. BeginOffset *int64 `type:"integer"` - // A character offset in the input text where the key phrase ends. The offset - // returns the position of each UTF-8 code point in the string. A code point - // is the abstract character from a particular graphical representation. For - // example, a multi-byte UTF-8 character maps to a single code point. + // The zero-based offset from the beginning of the source text to the last character + // in the key phrase. EndOffset *int64 `type:"integer"` // The level of confidence that Amazon Comprehend has in the accuracy of the @@ -16906,6 +17381,50 @@ func (s *ListTopicsDetectionJobsOutput) SetTopicsDetectionJobPropertiesList(v [] return s } +// Contains the sentiment and sentiment score for one mention of an entity. +// +// For more information about targeted sentiment, see Targeted sentiment (https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html). +type MentionSentiment struct { + _ struct{} `type:"structure"` + + // The sentiment of the mention. + Sentiment *string `type:"string" enum:"SentimentType"` + + // Describes the level of confidence that Amazon Comprehend has in the accuracy + // of its detection of sentiments. + SentimentScore *SentimentScore `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 MentionSentiment) 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 MentionSentiment) GoString() string { + return s.String() +} + +// SetSentiment sets the Sentiment field's value. +func (s *MentionSentiment) SetSentiment(v string) *MentionSentiment { + s.Sentiment = &v + return s +} + +// SetSentimentScore sets the SentimentScore field's value. +func (s *MentionSentiment) SetSentimentScore(v *SentimentScore) *MentionSentiment { + s.SentimentScore = v + return s +} + // Provides configuration parameters for the output of inference jobs. type OutputDataConfig struct { _ struct{} `type:"structure"` @@ -16988,7 +17507,8 @@ func (s *OutputDataConfig) SetS3Uri(v string) *OutputDataConfig { // 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 how-syntax. +// identify, see Syntax (https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html) +// in the Comprehend Developer Guide. type PartOfSpeechTag struct { _ struct{} `type:"structure"` @@ -17267,17 +17787,12 @@ func (s *PiiEntitiesDetectionJobProperties) SetSubmitTime(v time.Time) *PiiEntit type PiiEntity struct { _ struct{} `type:"structure"` - // A character offset in the input text that shows where the PII entity begins - // (the first character is at position 0). The offset returns the position of - // each UTF-8 code point in the string. A code point is the abstract character - // from a particular graphical representation. For example, a multi-byte UTF-8 - // character maps to a single code point. + // The zero-based offset from the beginning of the source text to the first + // character in the entity. BeginOffset *int64 `type:"integer"` - // A character offset in the input text that shows where the PII entity ends. - // The offset returns the position of each UTF-8 code point in the string. A - // code point is the abstract character from a particular graphical representation. - // For example, a multi-byte UTF-8 character maps to a single code point. + // The zero-based offset from the beginning of the source text to the last character + // in the entity. EndOffset *int64 `type:"integer"` // The level of confidence that Amazon Comprehend has in the accuracy of the @@ -19868,7 +20383,7 @@ type StartTargetedSentimentDetectionJobInput struct { // The identifier of the job. JobName *string `min:"1" type:"string"` - // The language of the input documents. Currently, English is the only valid + // The language of the input documents. Currently, English is the only supported // language. // // LanguageCode is a required field @@ -21125,7 +21640,8 @@ type SyntaxToken struct { // Provides the part of speech label and the confidence level that Amazon Comprehend // has that the part of speech was correctly identified. For more information, - // see how-syntax. + // see Syntax (https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html) + // in the Comprehend Developer Guide. PartOfSpeech *PartOfSpeechTag `type:"structure"` // The word that was recognized in the source text. @@ -21582,6 +22098,144 @@ func (s *TargetedSentimentDetectionJobProperties) SetVpcConfig(v *VpcConfig) *Ta return s } +// Information about one of the entities found by targeted sentiment analysis. +// +// For more information about targeted sentiment, see Targeted sentiment (https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html). +type TargetedSentimentEntity struct { + _ struct{} `type:"structure"` + + // One or more index into the Mentions array that provides the best name for + // the entity group. + DescriptiveMentionIndex []*int64 `type:"list"` + + // An array of mentions of the entity in the document. The array represents + // a co-reference group. See Co-reference group (https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html#how-targeted-sentiment-values) + // for an example. + Mentions []*TargetedSentimentMention `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 TargetedSentimentEntity) 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 TargetedSentimentEntity) GoString() string { + return s.String() +} + +// SetDescriptiveMentionIndex sets the DescriptiveMentionIndex field's value. +func (s *TargetedSentimentEntity) SetDescriptiveMentionIndex(v []*int64) *TargetedSentimentEntity { + s.DescriptiveMentionIndex = v + return s +} + +// SetMentions sets the Mentions field's value. +func (s *TargetedSentimentEntity) SetMentions(v []*TargetedSentimentMention) *TargetedSentimentEntity { + s.Mentions = v + return s +} + +// Information about one mention of an entity. The mention information includes +// the location of the mention in the text and the sentiment of the mention. +// +// For more information about targeted sentiment, see Targeted sentiment (https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html). +type TargetedSentimentMention struct { + _ struct{} `type:"structure"` + + // The offset into the document text where the mention begins. + BeginOffset *int64 `type:"integer"` + + // The offset into the document text where the mention ends. + EndOffset *int64 `type:"integer"` + + // The confidence that all the entities mentioned in the group relate to the + // same entity. + GroupScore *float64 `type:"float"` + + // Contains the sentiment and sentiment score for the mention. + MentionSentiment *MentionSentiment `type:"structure"` + + // Model confidence that the entity is relevant. Value range is zero to one, + // where one is highest confidence. + Score *float64 `type:"float"` + + // The text in the document that identifies the entity. + Text *string `min:"1" type:"string"` + + // The type of the entity. Amazon Comprehend supports a variety of entity types + // (https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html#how-targeted-sentiment-entities). + Type *string `type:"string" enum:"TargetedSentimentEntityType"` +} + +// 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 TargetedSentimentMention) 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 TargetedSentimentMention) GoString() string { + return s.String() +} + +// SetBeginOffset sets the BeginOffset field's value. +func (s *TargetedSentimentMention) SetBeginOffset(v int64) *TargetedSentimentMention { + s.BeginOffset = &v + return s +} + +// SetEndOffset sets the EndOffset field's value. +func (s *TargetedSentimentMention) SetEndOffset(v int64) *TargetedSentimentMention { + s.EndOffset = &v + return s +} + +// SetGroupScore sets the GroupScore field's value. +func (s *TargetedSentimentMention) SetGroupScore(v float64) *TargetedSentimentMention { + s.GroupScore = &v + return s +} + +// SetMentionSentiment sets the MentionSentiment field's value. +func (s *TargetedSentimentMention) SetMentionSentiment(v *MentionSentiment) *TargetedSentimentMention { + s.MentionSentiment = v + return s +} + +// SetScore sets the Score field's value. +func (s *TargetedSentimentMention) SetScore(v float64) *TargetedSentimentMention { + s.Score = &v + return s +} + +// SetText sets the Text field's value. +func (s *TargetedSentimentMention) SetText(v string) *TargetedSentimentMention { + s.Text = &v + return s +} + +// SetType sets the Type field's value. +func (s *TargetedSentimentMention) SetType(v string) *TargetedSentimentMention { + s.Type = &v + return s +} + // The size of the input text exceeds the limit. Use a smaller document. type TextSizeLimitExceededException struct { _ struct{} `type:"structure"` @@ -22082,7 +22736,9 @@ func (s *TopicsDetectionJobProperties) SetVpcConfig(v *VpcConfig) *TopicsDetecti // Amazon Comprehend can't process the language of the input text. For custom // entity recognition APIs, only English, Spanish, French, Italian, German, -// or Portuguese are accepted. For a list of supported languages, see supported-languages. +// or Portuguese are accepted. For a list of supported languages, Supported +// languages (https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html) +// in the Comprehend Developer Guide. type UnsupportedLanguageException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -23085,3 +23741,79 @@ func SyntaxLanguageCode_Values() []string { SyntaxLanguageCodePt, } } + +const ( + // TargetedSentimentEntityTypePerson is a TargetedSentimentEntityType enum value + TargetedSentimentEntityTypePerson = "PERSON" + + // TargetedSentimentEntityTypeLocation is a TargetedSentimentEntityType enum value + TargetedSentimentEntityTypeLocation = "LOCATION" + + // TargetedSentimentEntityTypeOrganization is a TargetedSentimentEntityType enum value + TargetedSentimentEntityTypeOrganization = "ORGANIZATION" + + // TargetedSentimentEntityTypeFacility is a TargetedSentimentEntityType enum value + TargetedSentimentEntityTypeFacility = "FACILITY" + + // TargetedSentimentEntityTypeBrand is a TargetedSentimentEntityType enum value + TargetedSentimentEntityTypeBrand = "BRAND" + + // TargetedSentimentEntityTypeCommercialItem is a TargetedSentimentEntityType enum value + TargetedSentimentEntityTypeCommercialItem = "COMMERCIAL_ITEM" + + // TargetedSentimentEntityTypeMovie is a TargetedSentimentEntityType enum value + TargetedSentimentEntityTypeMovie = "MOVIE" + + // TargetedSentimentEntityTypeMusic is a TargetedSentimentEntityType enum value + TargetedSentimentEntityTypeMusic = "MUSIC" + + // TargetedSentimentEntityTypeBook is a TargetedSentimentEntityType enum value + TargetedSentimentEntityTypeBook = "BOOK" + + // TargetedSentimentEntityTypeSoftware is a TargetedSentimentEntityType enum value + TargetedSentimentEntityTypeSoftware = "SOFTWARE" + + // TargetedSentimentEntityTypeGame is a TargetedSentimentEntityType enum value + TargetedSentimentEntityTypeGame = "GAME" + + // TargetedSentimentEntityTypePersonalTitle is a TargetedSentimentEntityType enum value + TargetedSentimentEntityTypePersonalTitle = "PERSONAL_TITLE" + + // TargetedSentimentEntityTypeEvent is a TargetedSentimentEntityType enum value + TargetedSentimentEntityTypeEvent = "EVENT" + + // TargetedSentimentEntityTypeDate is a TargetedSentimentEntityType enum value + TargetedSentimentEntityTypeDate = "DATE" + + // TargetedSentimentEntityTypeQuantity is a TargetedSentimentEntityType enum value + TargetedSentimentEntityTypeQuantity = "QUANTITY" + + // TargetedSentimentEntityTypeAttribute is a TargetedSentimentEntityType enum value + TargetedSentimentEntityTypeAttribute = "ATTRIBUTE" + + // TargetedSentimentEntityTypeOther is a TargetedSentimentEntityType enum value + TargetedSentimentEntityTypeOther = "OTHER" +) + +// TargetedSentimentEntityType_Values returns all elements of the TargetedSentimentEntityType enum +func TargetedSentimentEntityType_Values() []string { + return []string{ + TargetedSentimentEntityTypePerson, + TargetedSentimentEntityTypeLocation, + TargetedSentimentEntityTypeOrganization, + TargetedSentimentEntityTypeFacility, + TargetedSentimentEntityTypeBrand, + TargetedSentimentEntityTypeCommercialItem, + TargetedSentimentEntityTypeMovie, + TargetedSentimentEntityTypeMusic, + TargetedSentimentEntityTypeBook, + TargetedSentimentEntityTypeSoftware, + TargetedSentimentEntityTypeGame, + TargetedSentimentEntityTypePersonalTitle, + TargetedSentimentEntityTypeEvent, + TargetedSentimentEntityTypeDate, + TargetedSentimentEntityTypeQuantity, + TargetedSentimentEntityTypeAttribute, + TargetedSentimentEntityTypeOther, + } +} diff --git a/service/comprehend/comprehendiface/interface.go b/service/comprehend/comprehendiface/interface.go index 95690200bd..331f4f3b11 100644 --- a/service/comprehend/comprehendiface/interface.go +++ b/service/comprehend/comprehendiface/interface.go @@ -80,6 +80,10 @@ type ComprehendAPI interface { BatchDetectSyntaxWithContext(aws.Context, *comprehend.BatchDetectSyntaxInput, ...request.Option) (*comprehend.BatchDetectSyntaxOutput, error) BatchDetectSyntaxRequest(*comprehend.BatchDetectSyntaxInput) (*request.Request, *comprehend.BatchDetectSyntaxOutput) + BatchDetectTargetedSentiment(*comprehend.BatchDetectTargetedSentimentInput) (*comprehend.BatchDetectTargetedSentimentOutput, error) + BatchDetectTargetedSentimentWithContext(aws.Context, *comprehend.BatchDetectTargetedSentimentInput, ...request.Option) (*comprehend.BatchDetectTargetedSentimentOutput, error) + BatchDetectTargetedSentimentRequest(*comprehend.BatchDetectTargetedSentimentInput) (*request.Request, *comprehend.BatchDetectTargetedSentimentOutput) + ClassifyDocument(*comprehend.ClassifyDocumentInput) (*comprehend.ClassifyDocumentOutput, error) ClassifyDocumentWithContext(aws.Context, *comprehend.ClassifyDocumentInput, ...request.Option) (*comprehend.ClassifyDocumentOutput, error) ClassifyDocumentRequest(*comprehend.ClassifyDocumentInput) (*request.Request, *comprehend.ClassifyDocumentOutput) @@ -192,6 +196,10 @@ type ComprehendAPI interface { DetectSyntaxWithContext(aws.Context, *comprehend.DetectSyntaxInput, ...request.Option) (*comprehend.DetectSyntaxOutput, error) DetectSyntaxRequest(*comprehend.DetectSyntaxInput) (*request.Request, *comprehend.DetectSyntaxOutput) + DetectTargetedSentiment(*comprehend.DetectTargetedSentimentInput) (*comprehend.DetectTargetedSentimentOutput, error) + DetectTargetedSentimentWithContext(aws.Context, *comprehend.DetectTargetedSentimentInput, ...request.Option) (*comprehend.DetectTargetedSentimentOutput, error) + DetectTargetedSentimentRequest(*comprehend.DetectTargetedSentimentInput) (*request.Request, *comprehend.DetectTargetedSentimentOutput) + ImportModel(*comprehend.ImportModelInput) (*comprehend.ImportModelOutput, error) ImportModelWithContext(aws.Context, *comprehend.ImportModelInput, ...request.Option) (*comprehend.ImportModelOutput, error) ImportModelRequest(*comprehend.ImportModelInput) (*request.Request, *comprehend.ImportModelOutput) diff --git a/service/comprehend/errors.go b/service/comprehend/errors.go index 9c676c2bf1..804c8cbaa3 100644 --- a/service/comprehend/errors.go +++ b/service/comprehend/errors.go @@ -113,7 +113,9 @@ const ( // // Amazon Comprehend can't process the language of the input text. For custom // entity recognition APIs, only English, Spanish, French, Italian, German, - // or Portuguese are accepted. For a list of supported languages, see supported-languages. + // or Portuguese are accepted. For a list of supported languages, Supported + // languages (https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html) + // in the Comprehend Developer Guide. ErrCodeUnsupportedLanguageException = "UnsupportedLanguageException" ) diff --git a/service/s3control/api.go b/service/s3control/api.go index abd8491e5c..e5e442f633 100644 --- a/service/s3control/api.go +++ b/service/s3control/api.go @@ -74,11 +74,11 @@ func (c *S3Control) CreateAccessPointRequest(input *CreateAccessPointInput) (req // in the Amazon S3 User Guide. // // All Amazon S3 on Outposts REST API requests for this action require an additional -// parameter of x-amz-outpost-id to be passed with the request and an S3 on -// Outposts endpoint hostname prefix instead of s3-control. For an example of -// the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts -// endpoint hostname prefix and the x-amz-outpost-id derived using the access -// point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html#API_control_CreateAccessPoint_Examples) +// parameter of x-amz-outpost-id to be passed with the request. In addition, +// you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. +// For an example of the request syntax for Amazon S3 on Outposts that uses +// the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived +// by using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html#API_control_CreateAccessPoint_Examples) // section. // // The following actions are related to CreateAccessPoint: @@ -582,11 +582,11 @@ func (c *S3Control) DeleteAccessPointRequest(input *DeleteAccessPointInput) (req // Deletes the specified access point. // // All Amazon S3 on Outposts REST API requests for this action require an additional -// parameter of x-amz-outpost-id to be passed with the request and an S3 on -// Outposts endpoint hostname prefix instead of s3-control. For an example of -// the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts -// endpoint hostname prefix and the x-amz-outpost-id derived using the access -// point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html#API_control_DeleteAccessPoint_Examples) +// parameter of x-amz-outpost-id to be passed with the request. In addition, +// you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. +// For an example of the request syntax for Amazon S3 on Outposts that uses +// the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived +// by using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html#API_control_DeleteAccessPoint_Examples) // section. // // The following actions are related to DeleteAccessPoint: @@ -761,11 +761,11 @@ func (c *S3Control) DeleteAccessPointPolicyRequest(input *DeleteAccessPointPolic // Deletes the access point policy for the specified access point. // // All Amazon S3 on Outposts REST API requests for this action require an additional -// parameter of x-amz-outpost-id to be passed with the request and an S3 on -// Outposts endpoint hostname prefix instead of s3-control. For an example of -// the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts -// endpoint hostname prefix and the x-amz-outpost-id derived using the access -// point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicy.html#API_control_DeleteAccessPointPolicy_Examples) +// parameter of x-amz-outpost-id to be passed with the request. In addition, +// you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. +// For an example of the request syntax for Amazon S3 on Outposts that uses +// the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived +// by using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicy.html#API_control_DeleteAccessPointPolicy_Examples) // section. // // The following actions are related to DeleteAccessPointPolicy: @@ -944,11 +944,11 @@ func (c *S3Control) DeleteBucketRequest(input *DeleteBucketInput) (req *request. // in Amazon S3 User Guide. // // All Amazon S3 on Outposts REST API requests for this action require an additional -// parameter of x-amz-outpost-id to be passed with the request and an S3 on -// Outposts endpoint hostname prefix instead of s3-control. For an example of -// the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts -// endpoint hostname prefix and the x-amz-outpost-id derived using the access -// point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucket.html#API_control_DeleteBucket_Examples) +// parameter of x-amz-outpost-id to be passed with the request. In addition, +// you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. +// For an example of the request syntax for Amazon S3 on Outposts that uses +// the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived +// by using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucket.html#API_control_DeleteBucket_Examples) // section. // // Related Resources @@ -1054,11 +1054,11 @@ func (c *S3Control) DeleteBucketLifecycleConfigurationRequest(input *DeleteBucke // bucket owner can grant this permission to others. // // All Amazon S3 on Outposts REST API requests for this action require an additional -// parameter of x-amz-outpost-id to be passed with the request and an S3 on -// Outposts endpoint hostname prefix instead of s3-control. For an example of -// the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts -// endpoint hostname prefix and the x-amz-outpost-id derived using the access -// point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketLifecycleConfiguration.html#API_control_DeleteBucketLifecycleConfiguration_Examples) +// parameter of x-amz-outpost-id to be passed with the request. In addition, +// you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. +// For an example of the request syntax for Amazon S3 on Outposts that uses +// the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived +// by using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketLifecycleConfiguration.html#API_control_DeleteBucketLifecycleConfiguration_Examples) // section. // // For more information about object expiration, see Elements to Describe Lifecycle @@ -1173,11 +1173,11 @@ func (c *S3Control) DeleteBucketPolicyRequest(input *DeleteBucketPolicyInput) (r // User Policies (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html). // // All Amazon S3 on Outposts REST API requests for this action require an additional -// parameter of x-amz-outpost-id to be passed with the request and an S3 on -// Outposts endpoint hostname prefix instead of s3-control. For an example of -// the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts -// endpoint hostname prefix and the x-amz-outpost-id derived using the access -// point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketPolicy.html#API_control_DeleteBucketPolicy_Examples) +// parameter of x-amz-outpost-id to be passed with the request. In addition, +// you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. +// For an example of the request syntax for Amazon S3 on Outposts that uses +// the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived +// by using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketPolicy.html#API_control_DeleteBucketPolicy_Examples) // section. // // The following actions are related to DeleteBucketPolicy: @@ -1276,11 +1276,11 @@ func (c *S3Control) DeleteBucketTaggingRequest(input *DeleteBucketTaggingInput) // permission to others. // // All Amazon S3 on Outposts REST API requests for this action require an additional -// parameter of x-amz-outpost-id to be passed with the request and an S3 on -// Outposts endpoint hostname prefix instead of s3-control. For an example of -// the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts -// endpoint hostname prefix and the x-amz-outpost-id derived using the access -// point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketTagging.html#API_control_DeleteBucketTagging_Examples) +// parameter of x-amz-outpost-id to be passed with the request. In addition, +// you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. +// For an example of the request syntax for Amazon S3 on Outposts that uses +// the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived +// by using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketTagging.html#API_control_DeleteBucketTagging_Examples) // section. // // The following actions are related to DeleteBucketTagging: @@ -2007,11 +2007,11 @@ func (c *S3Control) GetAccessPointRequest(input *GetAccessPointInput) (req *requ // Returns configuration information about the specified access point. // // All Amazon S3 on Outposts REST API requests for this action require an additional -// parameter of x-amz-outpost-id to be passed with the request and an S3 on -// Outposts endpoint hostname prefix instead of s3-control. For an example of -// the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts -// endpoint hostname prefix and the x-amz-outpost-id derived using the access -// point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html#API_control_GetAccessPoint_Examples) +// parameter of x-amz-outpost-id to be passed with the request. In addition, +// you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. +// For an example of the request syntax for Amazon S3 on Outposts that uses +// the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived +// by using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html#API_control_GetAccessPoint_Examples) // section. // // The following actions are related to GetAccessPoint: @@ -2598,11 +2598,11 @@ func (c *S3Control) GetBucketRequest(input *GetBucketInput) (req *request.Reques // The following actions are related to GetBucket for Amazon S3 on Outposts: // // All Amazon S3 on Outposts REST API requests for this action require an additional -// parameter of x-amz-outpost-id to be passed with the request and an S3 on -// Outposts endpoint hostname prefix instead of s3-control. For an example of -// the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts -// endpoint hostname prefix and the x-amz-outpost-id derived using the access -// point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucket.html#API_control_GetBucket_Examples) +// parameter of x-amz-outpost-id to be passed with the request. In addition, +// you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. +// For an example of the request syntax for Amazon S3 on Outposts that uses +// the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived +// by using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucket.html#API_control_GetBucket_Examples) // section. // // - PutObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) @@ -2705,11 +2705,11 @@ func (c *S3Control) GetBucketLifecycleConfigurationRequest(input *GetBucketLifec // and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). // // All Amazon S3 on Outposts REST API requests for this action require an additional -// parameter of x-amz-outpost-id to be passed with the request and an S3 on -// Outposts endpoint hostname prefix instead of s3-control. For an example of -// the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts -// endpoint hostname prefix and the x-amz-outpost-id derived using the access -// point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html#API_control_GetBucketLifecycleConfiguration_Examples) +// parameter of x-amz-outpost-id to be passed with the request. In addition, +// you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. +// For an example of the request syntax for Amazon S3 on Outposts that uses +// the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived +// by using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html#API_control_GetBucketLifecycleConfiguration_Examples) // section. // // GetBucketLifecycleConfiguration has the following special error: @@ -2826,11 +2826,11 @@ func (c *S3Control) GetBucketPolicyRequest(input *GetBucketPolicyInput) (req *re // User Policies (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html). // // All Amazon S3 on Outposts REST API requests for this action require an additional -// parameter of x-amz-outpost-id to be passed with the request and an S3 on -// Outposts endpoint hostname prefix instead of s3-control. For an example of -// the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts -// endpoint hostname prefix and the x-amz-outpost-id derived using the access -// point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketPolicy.html#API_control_GetBucketPolicy_Examples) +// parameter of x-amz-outpost-id to be passed with the request. In addition, +// you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. +// For an example of the request syntax for Amazon S3 on Outposts that uses +// the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived +// by using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketPolicy.html#API_control_GetBucketPolicy_Examples) // section. // // The following actions are related to GetBucketPolicy: @@ -2935,11 +2935,11 @@ func (c *S3Control) GetBucketTaggingRequest(input *GetBucketTaggingInput) (req * // with the bucket. // // All Amazon S3 on Outposts REST API requests for this action require an additional -// parameter of x-amz-outpost-id to be passed with the request and an S3 on -// Outposts endpoint hostname prefix instead of s3-control. For an example of -// the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts -// endpoint hostname prefix and the x-amz-outpost-id derived using the access -// point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketTagging.html#API_control_GetBucketTagging_Examples) +// parameter of x-amz-outpost-id to be passed with the request. In addition, +// you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. +// For an example of the request syntax for Amazon S3 on Outposts that uses +// the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived +// by using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketTagging.html#API_control_GetBucketTagging_Examples) // section. // // The following actions are related to GetBucketTagging: @@ -2976,6 +2976,114 @@ func (c *S3Control) GetBucketTaggingWithContext(ctx aws.Context, input *GetBucke return out, req.Send() } +const opGetBucketVersioning = "GetBucketVersioning" + +// GetBucketVersioningRequest generates a "aws/request.Request" representing the +// client's request for the GetBucketVersioning 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 GetBucketVersioning for more information on using the GetBucketVersioning +// 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 GetBucketVersioningRequest method. +// req, resp := client.GetBucketVersioningRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/GetBucketVersioning +func (c *S3Control) GetBucketVersioningRequest(input *GetBucketVersioningInput) (req *request.Request, output *GetBucketVersioningOutput) { + op := &request.Operation{ + Name: opGetBucketVersioning, + HTTPMethod: "GET", + HTTPPath: "/v20180820/bucket/{name}/versioning", + } + + if input == nil { + input = &GetBucketVersioningInput{} + } + + output = &GetBucketVersioningOutput{} + req = c.newRequest(op, input, output) + // update account id or check if provided input for account id member matches + // the account id present in ARN + req.Handlers.Validate.PushFrontNamed(updateAccountIDWithARNHandler) + req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("{AccountId}.", input.hostLabels)) + req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) + return +} + +// GetBucketVersioning API operation for AWS S3 Control. +// +// This operation returns the versioning state only for S3 on Outposts buckets. +// To return the versioning state for an S3 bucket, see GetBucketVersioning +// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html) +// in the Amazon S3 API Reference. +// +// Returns the versioning state for an S3 on Outposts bucket. With versioning, +// you can save multiple distinct copies of your data and recover from unintended +// user actions and application failures. +// +// If you've never set versioning on your bucket, it has no versioning state. +// In that case, the GetBucketVersioning request does not return a versioning +// state value. +// +// For more information about versioning, see Versioning (https://docs.aws.amazon.com/AmazonS3/latest/userguide/Versioning.html) +// in the Amazon S3 User Guide. +// +// All Amazon S3 on Outposts REST API requests for this action require an additional +// parameter of x-amz-outpost-id to be passed with the request. In addition, +// you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. +// For an example of the request syntax for Amazon S3 on Outposts that uses +// the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived +// by using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketVersioning.html#API_control_GetBucketVersioning_Examples) +// section. +// +// The following operations are related to GetBucketVersioning for S3 on Outposts. +// +// - PutBucketVersioning (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketVersioning.html) +// +// - PutBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html) +// +// - GetBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.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 AWS S3 Control's +// API operation GetBucketVersioning for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/GetBucketVersioning +func (c *S3Control) GetBucketVersioning(input *GetBucketVersioningInput) (*GetBucketVersioningOutput, error) { + req, out := c.GetBucketVersioningRequest(input) + return out, req.Send() +} + +// GetBucketVersioningWithContext is the same as GetBucketVersioning with the addition of +// the ability to pass a context and additional request options. +// +// See GetBucketVersioning 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 *S3Control) GetBucketVersioningWithContext(ctx aws.Context, input *GetBucketVersioningInput, opts ...request.Option) (*GetBucketVersioningOutput, error) { + req, out := c.GetBucketVersioningRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opGetJobTagging = "GetJobTagging" // GetJobTaggingRequest generates a "aws/request.Request" representing the @@ -3661,11 +3769,11 @@ func (c *S3Control) ListAccessPointsRequest(input *ListAccessPointsInput) (req * // can use to list the additional access points. // // All Amazon S3 on Outposts REST API requests for this action require an additional -// parameter of x-amz-outpost-id to be passed with the request and an S3 on -// Outposts endpoint hostname prefix instead of s3-control. For an example of -// the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts -// endpoint hostname prefix and the x-amz-outpost-id derived using the access -// point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html#API_control_GetAccessPoint_Examples) +// parameter of x-amz-outpost-id to be passed with the request. In addition, +// you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. +// For an example of the request syntax for Amazon S3 on Outposts that uses +// the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived +// by using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html#API_control_GetAccessPoint_Examples) // section. // // The following actions are related to ListAccessPoints: @@ -4620,11 +4728,11 @@ func (c *S3Control) PutAccessPointPolicyRequest(input *PutAccessPointPolicyInput // existing policy associated with the specified access point. // // All Amazon S3 on Outposts REST API requests for this action require an additional -// parameter of x-amz-outpost-id to be passed with the request and an S3 on -// Outposts endpoint hostname prefix instead of s3-control. For an example of -// the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts -// endpoint hostname prefix and the x-amz-outpost-id derived using the access -// point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicy.html#API_control_PutAccessPointPolicy_Examples) +// parameter of x-amz-outpost-id to be passed with the request. In addition, +// you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. +// For an example of the request syntax for Amazon S3 on Outposts that uses +// the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived +// by using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicy.html#API_control_PutAccessPointPolicy_Examples) // section. // // The following actions are related to PutAccessPointPolicy: @@ -4809,11 +4917,11 @@ func (c *S3Control) PutBucketLifecycleConfigurationRequest(input *PutBucketLifec // and abort incomplete multipart uploads. // // All Amazon S3 on Outposts REST API requests for this action require an additional -// parameter of x-amz-outpost-id to be passed with the request and an S3 on -// Outposts endpoint hostname prefix instead of s3-control. For an example of -// the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts -// endpoint hostname prefix and the x-amz-outpost-id derived using the access -// point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html#API_control_PutBucketLifecycleConfiguration_Examples) +// parameter of x-amz-outpost-id to be passed with the request. In addition, +// you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. +// For an example of the request syntax for Amazon S3 on Outposts that uses +// the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived +// by using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html#API_control_PutBucketLifecycleConfiguration_Examples) // section. // // The following actions are related to PutBucketLifecycleConfiguration: @@ -4929,11 +5037,11 @@ func (c *S3Control) PutBucketPolicyRequest(input *PutBucketPolicyInput) (req *re // User Policies (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html). // // All Amazon S3 on Outposts REST API requests for this action require an additional -// parameter of x-amz-outpost-id to be passed with the request and an S3 on -// Outposts endpoint hostname prefix instead of s3-control. For an example of -// the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts -// endpoint hostname prefix and the x-amz-outpost-id derived using the access -// point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketPolicy.html#API_control_PutBucketPolicy_Examples) +// parameter of x-amz-outpost-id to be passed with the request. In addition, +// you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. +// For an example of the request syntax for Amazon S3 on Outposts that uses +// the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived +// by using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketPolicy.html#API_control_PutBucketPolicy_Examples) // section. // // The following actions are related to PutBucketPolicy: @@ -5068,11 +5176,11 @@ func (c *S3Control) PutBucketTaggingRequest(input *PutBucketTaggingInput) (req * // the provided tag to the bucket. // // All Amazon S3 on Outposts REST API requests for this action require an additional -// parameter of x-amz-outpost-id to be passed with the request and an S3 on -// Outposts endpoint hostname prefix instead of s3-control. For an example of -// the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts -// endpoint hostname prefix and the x-amz-outpost-id derived using the access -// point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketTagging.html#API_control_PutBucketTagging_Examples) +// parameter of x-amz-outpost-id to be passed with the request. In addition, +// you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. +// For an example of the request syntax for Amazon S3 on Outposts that uses +// the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived +// by using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketTagging.html#API_control_PutBucketTagging_Examples) // section. // // The following actions are related to PutBucketTagging: @@ -5109,6 +5217,137 @@ func (c *S3Control) PutBucketTaggingWithContext(ctx aws.Context, input *PutBucke return out, req.Send() } +const opPutBucketVersioning = "PutBucketVersioning" + +// PutBucketVersioningRequest generates a "aws/request.Request" representing the +// client's request for the PutBucketVersioning 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 PutBucketVersioning for more information on using the PutBucketVersioning +// 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 PutBucketVersioningRequest method. +// req, resp := client.PutBucketVersioningRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/PutBucketVersioning +func (c *S3Control) PutBucketVersioningRequest(input *PutBucketVersioningInput) (req *request.Request, output *PutBucketVersioningOutput) { + op := &request.Operation{ + Name: opPutBucketVersioning, + HTTPMethod: "PUT", + HTTPPath: "/v20180820/bucket/{name}/versioning", + } + + if input == nil { + input = &PutBucketVersioningInput{} + } + + output = &PutBucketVersioningOutput{} + req = c.newRequest(op, input, output) + // update account id or check if provided input for account id member matches + // the account id present in ARN + req.Handlers.Validate.PushFrontNamed(updateAccountIDWithARNHandler) + req.Handlers.Unmarshal.Swap(restxml.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + req.Handlers.Build.PushBackNamed(protocol.NewHostPrefixHandler("{AccountId}.", input.hostLabels)) + req.Handlers.Build.PushBackNamed(protocol.ValidateEndpointHostHandler) + req.Handlers.Build.PushBackNamed(request.NamedHandler{ + Name: "contentMd5Handler", + Fn: checksum.AddBodyContentMD5Handler, + }) + return +} + +// PutBucketVersioning API operation for AWS S3 Control. +// +// This operation sets the versioning state only for S3 on Outposts buckets. +// To set the versioning state for an S3 bucket, see PutBucketVersioning (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketVersioning.html) +// in the Amazon S3 API Reference. +// +// Sets the versioning state for an S3 on Outposts bucket. With versioning, +// you can save multiple distinct copies of your data and recover from unintended +// user actions and application failures. +// +// You can set the versioning state to one of the following: +// +// - Enabled - Enables versioning for the objects in the bucket. All objects +// added to the bucket receive a unique version ID. +// +// - Suspended - Suspends versioning for the objects in the bucket. All objects +// added to the bucket receive the version ID null. +// +// If you've never set versioning on your bucket, it has no versioning state. +// In that case, a GetBucketVersioning (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketVersioning.html) +// request does not return a versioning state value. +// +// When you enable S3 Versioning, for each object in your bucket, you have a +// current version and zero or more noncurrent versions. You can configure your +// bucket S3 Lifecycle rules to expire noncurrent versions after a specified +// time period. For more information, see Creating and managing a lifecycle +// configuration for your S3 on Outposts bucket (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsLifecycleManaging.html) +// in the Amazon S3 User Guide. +// +// If you have an object expiration lifecycle policy in your non-versioned bucket +// and you want to maintain the same permanent delete behavior when you enable +// versioning, you must add a noncurrent expiration policy. The noncurrent expiration +// lifecycle policy will manage the deletes of the noncurrent object versions +// in the version-enabled bucket. For more information, see Versioning (https://docs.aws.amazon.com/AmazonS3/latest/userguide/Versioning.html) +// in the Amazon S3 User Guide. +// +// All Amazon S3 on Outposts REST API requests for this action require an additional +// parameter of x-amz-outpost-id to be passed with the request. In addition, +// you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. +// For an example of the request syntax for Amazon S3 on Outposts that uses +// the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived +// by using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketVersioning.html#API_control_PutBucketVersioning_Examples) +// section. +// +// The following operations are related to PutBucketVersioning for S3 on Outposts. +// +// - GetBucketVersioning (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketVersioning.html) +// +// - PutBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html) +// +// - GetBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.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 AWS S3 Control's +// API operation PutBucketVersioning for usage and error information. +// See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/PutBucketVersioning +func (c *S3Control) PutBucketVersioning(input *PutBucketVersioningInput) (*PutBucketVersioningOutput, error) { + req, out := c.PutBucketVersioningRequest(input) + return out, req.Send() +} + +// PutBucketVersioningWithContext is the same as PutBucketVersioning with the addition of +// the ability to pass a context and additional request options. +// +// See PutBucketVersioning 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 *S3Control) PutBucketVersioningWithContext(ctx aws.Context, input *PutBucketVersioningInput, opts ...request.Option) (*PutBucketVersioningOutput, error) { + req, out := c.PutBucketVersioningRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opPutJobTagging = "PutJobTagging" // PutJobTaggingRequest generates a "aws/request.Request" representing the @@ -5377,7 +5616,7 @@ func (c *S3Control) PutPublicAccessBlockRequest(input *PutPublicAccessBlockInput // PutPublicAccessBlock API operation for AWS S3 Control. // // Creates or modifies the PublicAccessBlock configuration for an Amazon Web -// Services account. For this operation, users must have the s3:PutBucketPublicAccessBlock +// Services account. For this operation, users must have the s3:PutAccountPublicAccessBlock // permission. For more information, see Using Amazon S3 block public access // (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html). // @@ -6005,7 +6244,7 @@ type AsyncErrorDetails struct { // A string that uniquely identifies the error condition. Code *string `type:"string"` - // A generic descritpion of the error condition in English. + // A generic description of the error condition in English. Message *string `type:"string"` // The ID of the request associated with the error. @@ -6822,7 +7061,7 @@ type CreateBucketInput struct { // The ID of the Outposts where the bucket is being created. // - // This is required by Amazon S3 on Outposts buckets. + // This ID is required by Amazon S3 on Outposts buckets. OutpostId *string `location:"header" locationName:"x-amz-outpost-id" min:"1" type:"string"` } @@ -10955,6 +11194,162 @@ func (s *GetBucketTaggingOutput) SetTagSet(v []*S3Tag) *GetBucketTaggingOutput { return s } +type GetBucketVersioningInput struct { + _ struct{} `locationName:"GetBucketVersioningRequest" type:"structure"` + + // The Amazon Web Services account ID of the S3 on Outposts bucket. + // + // AccountId is a required field + AccountId *string `location:"header" locationName:"x-amz-account-id" type:"string" required:"true"` + + // The S3 on Outposts bucket to return the versioning state for. + // + // Bucket is a required field + Bucket *string `location:"uri" locationName:"name" min:"3" 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 GetBucketVersioningInput) 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 GetBucketVersioningInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetBucketVersioningInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetBucketVersioningInput"} + if s.AccountId == nil { + invalidParams.Add(request.NewErrParamRequired("AccountId")) + } + if s.AccountId != nil && len(*s.AccountId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AccountId", 1)) + } + if s.Bucket == nil { + invalidParams.Add(request.NewErrParamRequired("Bucket")) + } + if s.Bucket != nil && len(*s.Bucket) < 3 { + invalidParams.Add(request.NewErrParamMinLen("Bucket", 3)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAccountId sets the AccountId field's value. +func (s *GetBucketVersioningInput) SetAccountId(v string) *GetBucketVersioningInput { + s.AccountId = &v + return s +} + +// SetBucket sets the Bucket field's value. +func (s *GetBucketVersioningInput) SetBucket(v string) *GetBucketVersioningInput { + s.Bucket = &v + return s +} + +func (s *GetBucketVersioningInput) hostLabels() map[string]string { + return map[string]string{ + "AccountId": aws.StringValue(s.AccountId), + } +} + +func (s *GetBucketVersioningInput) getEndpointARN() (arn.Resource, error) { + if s.Bucket == nil { + return nil, fmt.Errorf("member Bucket is nil") + } + return parseEndpointARN(*s.Bucket) +} + +func (s *GetBucketVersioningInput) hasEndpointARN() bool { + if s.Bucket == nil { + return false + } + return arn.IsARN(*s.Bucket) +} + +// updateArnableField updates the value of the input field that +// takes an ARN as an input. This method is useful to backfill +// the parsed resource name from ARN into the input member. +// It returns a pointer to a modified copy of input and an error. +// Note that original input is not modified. +func (s GetBucketVersioningInput) updateArnableField(v string) (interface{}, error) { + if s.Bucket == nil { + return nil, fmt.Errorf("member Bucket is nil") + } + s.Bucket = aws.String(v) + return &s, nil +} + +// updateAccountID returns a pointer to a modified copy of input, +// if account id is not provided, we update the account id in modified input +// if account id is provided, but doesn't match with the one in ARN, we throw an error +// if account id is not updated, we return nil. Note that original input is not modified. +func (s GetBucketVersioningInput) updateAccountID(accountId string) (interface{}, error) { + if s.AccountId == nil { + s.AccountId = aws.String(accountId) + return &s, nil + } else if *s.AccountId != accountId { + return &s, fmt.Errorf("Account ID mismatch, the Account ID cannot be specified in an ARN and in the accountId field") + } + return nil, nil +} + +type GetBucketVersioningOutput struct { + _ struct{} `type:"structure"` + + // Specifies whether MFA delete is enabled in the bucket versioning configuration. + // This element is returned only if the bucket has been configured with MFA + // delete. If MFA delete has never been configured for the bucket, this element + // is not returned. + MFADelete *string `locationName:"MfaDelete" type:"string" enum:"MFADeleteStatus"` + + // The versioning state of the S3 on Outposts bucket. + Status *string `type:"string" enum:"BucketVersioningStatus"` +} + +// 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 GetBucketVersioningOutput) 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 GetBucketVersioningOutput) GoString() string { + return s.String() +} + +// SetMFADelete sets the MFADelete field's value. +func (s *GetBucketVersioningOutput) SetMFADelete(v string) *GetBucketVersioningOutput { + s.MFADelete = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *GetBucketVersioningOutput) SetStatus(v string) *GetBucketVersioningOutput { + s.Status = &v + return s +} + type GetJobTaggingInput struct { _ struct{} `locationName:"GetJobTaggingRequest" type:"structure"` @@ -13737,9 +14132,9 @@ type ListRegionalBucketsInput struct { NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` - // The ID of the Outposts. + // The ID of the Outposts resource. // - // This is required by Amazon S3 on Outposts buckets. + // This ID is required by Amazon S3 on Outposts buckets. OutpostId *string `location:"header" locationName:"x-amz-outpost-id" min:"1" type:"string"` } @@ -14162,7 +14557,7 @@ type MultiRegionAccessPointReport struct { // The current status of the Multi-Region Access Point. // // CREATING and DELETING are temporary states that exist while the request is - // propogating and being completed. If a Multi-Region Access Point has a status + // propagating and being completed. If a Multi-Region Access Point has a status // of PARTIALLY_CREATED, you can retry creation or send a request to delete // the Multi-Region Access Point. If a Multi-Region Access Point has a status // of PARTIALLY_DELETED, you can retry a delete request to finish the deletion @@ -15739,6 +16134,165 @@ func (s PutBucketTaggingOutput) GoString() string { return s.String() } +type PutBucketVersioningInput struct { + _ struct{} `locationName:"PutBucketVersioningRequest" type:"structure" payload:"VersioningConfiguration"` + + // The Amazon Web Services account ID of the S3 on Outposts bucket. + // + // AccountId is a required field + AccountId *string `location:"header" locationName:"x-amz-account-id" type:"string" required:"true"` + + // The S3 on Outposts bucket to set the versioning state for. + // + // Bucket is a required field + Bucket *string `location:"uri" locationName:"name" min:"3" type:"string" required:"true"` + + // The concatenation of the authentication device's serial number, a space, + // and the value that is displayed on your authentication device. + MFA *string `location:"header" locationName:"x-amz-mfa" type:"string"` + + // The root-level tag for the VersioningConfiguration parameters. + // + // VersioningConfiguration is a required field + VersioningConfiguration *VersioningConfiguration `locationName:"VersioningConfiguration" type:"structure" required:"true" xmlURI:"http://awss3control.amazonaws.com/doc/2018-08-20/"` +} + +// 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 PutBucketVersioningInput) 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 PutBucketVersioningInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *PutBucketVersioningInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "PutBucketVersioningInput"} + if s.AccountId == nil { + invalidParams.Add(request.NewErrParamRequired("AccountId")) + } + if s.AccountId != nil && len(*s.AccountId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AccountId", 1)) + } + if s.Bucket == nil { + invalidParams.Add(request.NewErrParamRequired("Bucket")) + } + if s.Bucket != nil && len(*s.Bucket) < 3 { + invalidParams.Add(request.NewErrParamMinLen("Bucket", 3)) + } + if s.VersioningConfiguration == nil { + invalidParams.Add(request.NewErrParamRequired("VersioningConfiguration")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAccountId sets the AccountId field's value. +func (s *PutBucketVersioningInput) SetAccountId(v string) *PutBucketVersioningInput { + s.AccountId = &v + return s +} + +// SetBucket sets the Bucket field's value. +func (s *PutBucketVersioningInput) SetBucket(v string) *PutBucketVersioningInput { + s.Bucket = &v + return s +} + +// SetMFA sets the MFA field's value. +func (s *PutBucketVersioningInput) SetMFA(v string) *PutBucketVersioningInput { + s.MFA = &v + return s +} + +// SetVersioningConfiguration sets the VersioningConfiguration field's value. +func (s *PutBucketVersioningInput) SetVersioningConfiguration(v *VersioningConfiguration) *PutBucketVersioningInput { + s.VersioningConfiguration = v + return s +} + +func (s *PutBucketVersioningInput) hostLabels() map[string]string { + return map[string]string{ + "AccountId": aws.StringValue(s.AccountId), + } +} + +func (s *PutBucketVersioningInput) getEndpointARN() (arn.Resource, error) { + if s.Bucket == nil { + return nil, fmt.Errorf("member Bucket is nil") + } + return parseEndpointARN(*s.Bucket) +} + +func (s *PutBucketVersioningInput) hasEndpointARN() bool { + if s.Bucket == nil { + return false + } + return arn.IsARN(*s.Bucket) +} + +// updateArnableField updates the value of the input field that +// takes an ARN as an input. This method is useful to backfill +// the parsed resource name from ARN into the input member. +// It returns a pointer to a modified copy of input and an error. +// Note that original input is not modified. +func (s PutBucketVersioningInput) updateArnableField(v string) (interface{}, error) { + if s.Bucket == nil { + return nil, fmt.Errorf("member Bucket is nil") + } + s.Bucket = aws.String(v) + return &s, nil +} + +// updateAccountID returns a pointer to a modified copy of input, +// if account id is not provided, we update the account id in modified input +// if account id is provided, but doesn't match with the one in ARN, we throw an error +// if account id is not updated, we return nil. Note that original input is not modified. +func (s PutBucketVersioningInput) updateAccountID(accountId string) (interface{}, error) { + if s.AccountId == nil { + s.AccountId = aws.String(accountId) + return &s, nil + } else if *s.AccountId != accountId { + return &s, fmt.Errorf("Account ID mismatch, the Account ID cannot be specified in an ARN and in the accountId field") + } + return nil, nil +} + +type PutBucketVersioningOutput 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 PutBucketVersioningOutput) 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 PutBucketVersioningOutput) GoString() string { + return s.String() +} + type PutJobTaggingInput struct { _ struct{} `locationName:"PutJobTaggingRequest" type:"structure" xmlURI:"http://awss3control.amazonaws.com/doc/2018-08-20/"` @@ -18119,8 +18673,8 @@ type SSEKMSEncryption struct { _ struct{} `locationName:"SSE-KMS" type:"structure"` // Specifies the ID of the Amazon Web Services Key Management Service (Amazon - // Web Services KMS) symmetric customer managed key to use for encrypting generated - // manifest objects. + // Web Services KMS) symmetric encryption customer managed key to use for encrypting + // generated manifest objects. // // KeyId is a required field KeyId *string `min:"1" type:"string" required:"true"` @@ -19047,6 +19601,49 @@ func (s *UpdateJobStatusOutput) SetStatusUpdateReason(v string) *UpdateJobStatus return s } +// Describes the versioning state of an Amazon S3 on Outposts bucket. For more +// information, see PutBucketVersioning (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketVersioning.html). +type VersioningConfiguration struct { + _ struct{} `type:"structure"` + + // Specifies whether MFA delete is enabled or disabled in the bucket versioning + // configuration for the S3 on Outposts bucket. + MFADelete *string `locationName:"MfaDelete" type:"string" enum:"MFADelete"` + + // Sets the versioning state of the S3 on Outposts bucket. + Status *string `type:"string" enum:"BucketVersioningStatus"` +} + +// 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 VersioningConfiguration) 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 VersioningConfiguration) GoString() string { + return s.String() +} + +// SetMFADelete sets the MFADelete field's value. +func (s *VersioningConfiguration) SetMFADelete(v string) *VersioningConfiguration { + s.MFADelete = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *VersioningConfiguration) SetStatus(v string) *VersioningConfiguration { + s.Status = &v + return s +} + // The virtual private cloud (VPC) configuration for an access point. type VpcConfiguration struct { _ struct{} `type:"structure"` @@ -19194,6 +19791,22 @@ func BucketLocationConstraint_Values() []string { } } +const ( + // BucketVersioningStatusEnabled is a BucketVersioningStatus enum value + BucketVersioningStatusEnabled = "Enabled" + + // BucketVersioningStatusSuspended is a BucketVersioningStatus enum value + BucketVersioningStatusSuspended = "Suspended" +) + +// BucketVersioningStatus_Values returns all elements of the BucketVersioningStatus enum +func BucketVersioningStatus_Values() []string { + return []string{ + BucketVersioningStatusEnabled, + BucketVersioningStatusSuspended, + } +} + const ( // ExpirationStatusEnabled is a ExpirationStatus enum value ExpirationStatusEnabled = "Enabled" @@ -19366,6 +19979,38 @@ func JobStatus_Values() []string { } } +const ( + // MFADeleteEnabled is a MFADelete enum value + MFADeleteEnabled = "Enabled" + + // MFADeleteDisabled is a MFADelete enum value + MFADeleteDisabled = "Disabled" +) + +// MFADelete_Values returns all elements of the MFADelete enum +func MFADelete_Values() []string { + return []string{ + MFADeleteEnabled, + MFADeleteDisabled, + } +} + +const ( + // MFADeleteStatusEnabled is a MFADeleteStatus enum value + MFADeleteStatusEnabled = "Enabled" + + // MFADeleteStatusDisabled is a MFADeleteStatus enum value + MFADeleteStatusDisabled = "Disabled" +) + +// MFADeleteStatus_Values returns all elements of the MFADeleteStatus enum +func MFADeleteStatus_Values() []string { + return []string{ + MFADeleteStatusEnabled, + MFADeleteStatusDisabled, + } +} + const ( // MultiRegionAccessPointStatusReady is a MultiRegionAccessPointStatus enum value MultiRegionAccessPointStatusReady = "READY" diff --git a/service/s3control/s3controliface/interface.go b/service/s3control/s3controliface/interface.go index 50b6a54b6f..eda44b59d0 100644 --- a/service/s3control/s3controliface/interface.go +++ b/service/s3control/s3controliface/interface.go @@ -184,6 +184,10 @@ type S3ControlAPI interface { GetBucketTaggingWithContext(aws.Context, *s3control.GetBucketTaggingInput, ...request.Option) (*s3control.GetBucketTaggingOutput, error) GetBucketTaggingRequest(*s3control.GetBucketTaggingInput) (*request.Request, *s3control.GetBucketTaggingOutput) + GetBucketVersioning(*s3control.GetBucketVersioningInput) (*s3control.GetBucketVersioningOutput, error) + GetBucketVersioningWithContext(aws.Context, *s3control.GetBucketVersioningInput, ...request.Option) (*s3control.GetBucketVersioningOutput, error) + GetBucketVersioningRequest(*s3control.GetBucketVersioningInput) (*request.Request, *s3control.GetBucketVersioningOutput) + GetJobTagging(*s3control.GetJobTaggingInput) (*s3control.GetJobTaggingOutput, error) GetJobTaggingWithContext(aws.Context, *s3control.GetJobTaggingInput, ...request.Option) (*s3control.GetJobTaggingOutput, error) GetJobTaggingRequest(*s3control.GetJobTaggingInput) (*request.Request, *s3control.GetJobTaggingOutput) @@ -278,6 +282,10 @@ type S3ControlAPI interface { PutBucketTaggingWithContext(aws.Context, *s3control.PutBucketTaggingInput, ...request.Option) (*s3control.PutBucketTaggingOutput, error) PutBucketTaggingRequest(*s3control.PutBucketTaggingInput) (*request.Request, *s3control.PutBucketTaggingOutput) + PutBucketVersioning(*s3control.PutBucketVersioningInput) (*s3control.PutBucketVersioningOutput, error) + PutBucketVersioningWithContext(aws.Context, *s3control.PutBucketVersioningInput, ...request.Option) (*s3control.PutBucketVersioningOutput, error) + PutBucketVersioningRequest(*s3control.PutBucketVersioningInput) (*request.Request, *s3control.PutBucketVersioningOutput) + PutJobTagging(*s3control.PutJobTaggingInput) (*s3control.PutJobTaggingOutput, error) PutJobTaggingWithContext(aws.Context, *s3control.PutJobTaggingInput, ...request.Option) (*s3control.PutJobTaggingOutput, error) PutJobTaggingRequest(*s3control.PutJobTaggingInput) (*request.Request, *s3control.PutJobTaggingOutput) diff --git a/service/sagemaker/api.go b/service/sagemaker/api.go index b30d93499d..59cec70600 100644 --- a/service/sagemaker/api.go +++ b/service/sagemaker/api.go @@ -4558,7 +4558,7 @@ func (c *SageMaker) CreateUserProfileRequest(input *CreateUserProfileInput) (req // domain, and is the main way to reference a "person" for the purposes of sharing, // reporting, and other user-oriented features. This entity is created when // a user onboards to Amazon SageMaker Studio. If an administrator invites a -// person by email or imports them from Amazon Web Services SSO, a user profile +// person by email or imports them from IAM Identity Center, a user profile // is automatically created. A user profile is the primary holder of settings // for an individual user and has a reference to the user's private Amazon Elastic // File System (EFS) home directory. @@ -5603,9 +5603,9 @@ func (c *SageMaker) DeleteDomainRequest(input *DeleteDomainInput) (req *request. // DeleteDomain API operation for Amazon SageMaker Service. // // Used to delete a domain. If you onboarded with IAM mode, you will need to -// delete your domain to onboard again using Amazon Web Services SSO. Use with -// caution. All of the members of the domain will lose access to their EFS volume, -// including data, notebooks, and other artifacts. +// delete your domain to onboard again using IAM Identity Center. Use with caution. +// All of the members of the domain will lose access to their EFS volume, including +// data, notebooks, and other artifacts. // // 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 @@ -27729,11 +27729,28 @@ type AutoMLCandidateGenerationConfig struct { _ struct{} `type:"structure"` // A URL to the Amazon S3 data source containing selected features from the - // input data source to run an Autopilot job (optional). This file should be - // in json format as shown below: + // input data source to run an Autopilot job. You can input FeatureAttributeNames + // (optional) in JSON format as shown below: // // { "FeatureAttributeNames":["col1", "col2", ...] }. // + // You can also specify the data type of the feature (optional) in the format + // shown below: + // + // { "FeatureDataTypes":{"col1":"numeric", "col2":"categorical" ... } } + // + // These column keys may not include the target column. + // + // In ensembling mode, Autopilot will only support the following data types: + // numeric, categorical, text and datetime. In HPO mode, Autopilot can support + // numeric, categorical, text, datetime and sequence. + // + // If only FeatureDataTypes is provided, the column keys (col1, col2,..) should + // be a subset of the column names in the input data. + // + // If both FeatureDataTypes and FeatureAttributeNames are provided, then the + // column keys should be a subset of the column names provided in FeatureAttributeNames. + // // The key name FeatureAttributeNames is fixed. The values listed in ["col1", // "col2", ...] is case sensitive and should be a list of strings containing // unique values that are a subset of the column names in the input data. The @@ -29377,6 +29394,53 @@ func (s *CandidateProperties) SetCandidateMetrics(v []*MetricDatum) *CandidatePr return s } +// The SageMaker Canvas app settings. +type CanvasAppSettings struct { + _ struct{} `type:"structure"` + + // Time series forecast settings for the Canvas app. + TimeSeriesForecastingSettings *TimeSeriesForecastingSettings `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 CanvasAppSettings) 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 CanvasAppSettings) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CanvasAppSettings) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CanvasAppSettings"} + if s.TimeSeriesForecastingSettings != nil { + if err := s.TimeSeriesForecastingSettings.Validate(); err != nil { + invalidParams.AddNested("TimeSeriesForecastingSettings", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetTimeSeriesForecastingSettings sets the TimeSeriesForecastingSettings field's value. +func (s *CanvasAppSettings) SetTimeSeriesForecastingSettings(v *TimeSeriesForecastingSettings) *CanvasAppSettings { + s.TimeSeriesForecastingSettings = v + return s +} + // Specifies the endpoint capacity to activate for production. type CapacitySize struct { _ struct{} `type:"structure"` @@ -39751,16 +39815,16 @@ type CreateUserProfileInput struct { DomainId *string `type:"string" required:"true"` // A specifier for the type of value specified in SingleSignOnUserValue. Currently, - // the only supported value is "UserName". If the Domain's AuthMode is Amazon - // Web Services SSO, this field is required. If the Domain's AuthMode is not - // Amazon Web Services SSO, this field cannot be specified. + // the only supported value is "UserName". If the Domain's AuthMode is IAM Identity + // Center, this field is required. If the Domain's AuthMode is not IAM Identity + // Center, this field cannot be specified. SingleSignOnUserIdentifier *string `type:"string"` // The username of the associated Amazon Web Services Single Sign-On User for - // this UserProfile. If the Domain's AuthMode is Amazon Web Services SSO, this - // field is required, and must match a valid username of a user in your directory. - // If the Domain's AuthMode is not Amazon Web Services SSO, this field cannot - // be specified. + // this UserProfile. If the Domain's AuthMode is IAM Identity Center, this field + // is required, and must match a valid username of a user in your directory. + // If the Domain's AuthMode is not IAM Identity Center, this field cannot be + // specified. SingleSignOnUserValue *string `type:"string"` // Each tag consists of a key and an optional value. Tag keys must be unique @@ -47149,7 +47213,7 @@ type DescribeDomainOutput struct { // apps and the RStudioServerPro app. SecurityGroupIdForDomainBoundary *string `type:"string"` - // The Amazon Web Services SSO managed application instance ID. + // The IAM Identity Center managed application instance ID. SingleSignOnManagedApplicationInstanceId *string `type:"string"` // The status. @@ -54445,10 +54509,10 @@ type DescribeUserProfileOutput struct { // The last modified time. LastModifiedTime *time.Time `type:"timestamp"` - // The Amazon Web Services SSO user identifier. + // The IAM Identity Center user identifier. SingleSignOnUserIdentifier *string `type:"string"` - // The Amazon Web Services SSO user value. + // The IAM Identity Center user value. SingleSignOnUserValue *string `type:"string"` // The status. @@ -62243,8 +62307,8 @@ func (s *HyperParameterTuningJobObjective) SetType(v string) *HyperParameterTuni return s } -// An entity having characteristics over which a user can search for a hyperparameter -// tuning job. +// An entity returned by the SearchRecord (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_SearchRecord.html) +// API containing the properties of a hyperparameter tuning job. type HyperParameterTuningJobSearchEntity struct { _ struct{} `type:"structure"` @@ -90478,6 +90542,68 @@ func (s *TensorBoardOutputConfig) SetS3OutputPath(v string) *TensorBoardOutputCo return s } +// Time series forecast settings for the SageMaker Canvas app. +type TimeSeriesForecastingSettings struct { + _ struct{} `type:"structure"` + + // The IAM role that Canvas passes to Amazon Forecast for time series forecasting. + // By default, Canvas uses the execution role specified in the UserProfile that + // launches the Canvas app. If an execution role is not specified in the UserProfile, + // Canvas uses the execution role specified in the Domain that owns the UserProfile. + // To allow time series forecasting, this IAM role should have the AmazonSageMakerCanvasForecastAccess + // (https://docs.aws.amazon.com/sagemaker/latest/dg/security-iam-awsmanpol-canvas.html#security-iam-awsmanpol-AmazonSageMakerCanvasForecastAccess) + // policy attached and forecast.amazonaws.com added in the trust relationship + // as a service principal. + AmazonForecastRoleArn *string `min:"20" type:"string"` + + // Describes whether time series forecasting is enabled or disabled in the Canvas + // app. + Status *string `type:"string" enum:"FeatureStatus"` +} + +// 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 TimeSeriesForecastingSettings) 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 TimeSeriesForecastingSettings) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *TimeSeriesForecastingSettings) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "TimeSeriesForecastingSettings"} + if s.AmazonForecastRoleArn != nil && len(*s.AmazonForecastRoleArn) < 20 { + invalidParams.Add(request.NewErrParamMinLen("AmazonForecastRoleArn", 20)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAmazonForecastRoleArn sets the AmazonForecastRoleArn field's value. +func (s *TimeSeriesForecastingSettings) SetAmazonForecastRoleArn(v string) *TimeSeriesForecastingSettings { + s.AmazonForecastRoleArn = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *TimeSeriesForecastingSettings) SetStatus(v string) *TimeSeriesForecastingSettings { + s.Status = &v + return s +} + // Defines the traffic pattern of the load test. type TrafficPattern struct { _ struct{} `type:"structure"` @@ -97476,6 +97602,9 @@ func (s *UserProfileDetails) SetUserProfileName(v string) *UserProfileDetails { type UserSettings struct { _ struct{} `type:"structure"` + // The Canvas app settings. + CanvasAppSettings *CanvasAppSettings `type:"structure"` + // The execution role for the user. ExecutionRole *string `min:"20" type:"string"` @@ -97535,6 +97664,11 @@ func (s *UserSettings) Validate() error { if s.ExecutionRole != nil && len(*s.ExecutionRole) < 20 { invalidParams.Add(request.NewErrParamMinLen("ExecutionRole", 20)) } + if s.CanvasAppSettings != nil { + if err := s.CanvasAppSettings.Validate(); err != nil { + invalidParams.AddNested("CanvasAppSettings", err.(request.ErrInvalidParams)) + } + } if s.KernelGatewayAppSettings != nil { if err := s.KernelGatewayAppSettings.Validate(); err != nil { invalidParams.AddNested("KernelGatewayAppSettings", err.(request.ErrInvalidParams)) @@ -97552,6 +97686,12 @@ func (s *UserSettings) Validate() error { return nil } +// SetCanvasAppSettings sets the CanvasAppSettings field's value. +func (s *UserSettings) SetCanvasAppSettings(v *CanvasAppSettings) *UserSettings { + s.CanvasAppSettings = v + return s +} + // SetExecutionRole sets the ExecutionRole field's value. func (s *UserSettings) SetExecutionRole(v string) *UserSettings { s.ExecutionRole = &v @@ -99801,6 +99941,22 @@ func FeatureGroupStatus_Values() []string { } } +const ( + // FeatureStatusEnabled is a FeatureStatus enum value + FeatureStatusEnabled = "ENABLED" + + // FeatureStatusDisabled is a FeatureStatus enum value + FeatureStatusDisabled = "DISABLED" +) + +// FeatureStatus_Values returns all elements of the FeatureStatus enum +func FeatureStatus_Values() []string { + return []string{ + FeatureStatusEnabled, + FeatureStatusDisabled, + } +} + const ( // FeatureTypeIntegral is a FeatureType enum value FeatureTypeIntegral = "Integral"