Indicates whether Amazon Kendra indexes attachments to the pages and blogs in the Confluence data source.
", + "ConfluenceSpaceConfiguration$CrawlPersonalSpaces": "Specifies whether Amazon Kendra should index personal spaces. Users can add restrictions to items in personal spaces. If personal spaces are indexed, queries without user context information may return restricted items from a personal space in their results. For more information, see Filtering on user context.
", + "ConfluenceSpaceConfiguration$CrawlArchivedSpaces": "Specifies whether Amazon Kendra should index archived spaces.
", "Highlight$TopAnswer": "Indicates whether the response is the best response. True if this is the best response; otherwise, false.
", "SalesforceConfiguration$CrawlAttachments": "Indicates whether Amazon Kendra should index attachments to Salesforce objects.
", "Search$Facetable": "Indicates that the field can be used to create search facets, a count of results for each value in the field. The default is false .
Specifies the attachment settings for the Confluence data source. Attachment settings are optional, if you don't specify settings attachments, Amazon Kendra won't index them.
", + "refs": { + "ConfluenceConfiguration$AttachmentConfiguration": "Specifies configuration information for indexing attachments to Confluence blogs and pages.
" + } + }, + "ConfluenceAttachmentFieldMappingsList": { + "base": null, + "refs": { + "ConfluenceAttachmentConfiguration$AttachmentFieldMappings": "Defines how attachment metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex operation.
If you specify the AttachentFieldMappings parameter, you must specify at least one field mapping.
The name of the field in the data source.
You must first create the index field using the operation.
" + } + }, + "ConfluenceAttachmentToIndexFieldMapping": { + "base": "Defines the mapping between a field in the Confluence data source to a Amazon Kendra index field.
You must first create the index field using the operation.
", + "refs": { + "ConfluenceAttachmentFieldMappingsList$member": null + } + }, + "ConfluenceBlogConfiguration": { + "base": "Specifies the blog settings for the Confluence data source. Blogs are always indexed unless filtered from the index by the ExclusionPatterns or InclusionPatterns fields in the data type.
Specifies configuration information for indexing Confluence blogs.
" + } + }, + "ConfluenceBlogFieldMappingsList": { + "base": null, + "refs": { + "ConfluenceBlogConfiguration$BlogFieldMappings": "Defines how blog metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex operation.
If you specify the BlogFieldMappings parameter, you must specify at least one field mapping.
The name of the field in the data source.
" + } + }, + "ConfluenceBlogToIndexFieldMapping": { + "base": "Defines the mapping between a blog field in the Confluence data source to a Amazon Kendra index field.
You must first create the index field using the operation.
", + "refs": { + "ConfluenceBlogFieldMappingsList$member": null + } + }, + "ConfluenceConfiguration": { + "base": "Provides configuration information for data sources that connect to Confluence.
", + "refs": { + "DataSourceConfiguration$ConfluenceConfiguration": "Provides configuration information for connecting to a Confluence data source.
" + } + }, + "ConfluencePageConfiguration": { + "base": "Specifies the page settings for the Confluence data source.
", + "refs": { + "ConfluenceConfiguration$PageConfiguration": "Specifies configuration information for indexing Confluence pages.
" + } + }, + "ConfluencePageFieldMappingsList": { + "base": null, + "refs": { + "ConfluencePageConfiguration$PageFieldMappings": "Defines how page metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex operation.
If you specify the PageFieldMappings parameter, you must specify at least one field mapping.
The name of the field in the data source.
" + } + }, + "ConfluencePageToIndexFieldMapping": { + "base": "Defines the mapping between a field in the Confluence data source to a Amazon Kendra index field.
You must first create the index field using the operation.
", + "refs": { + "ConfluencePageFieldMappingsList$member": null + } + }, + "ConfluenceSpaceConfiguration": { + "base": "Specifies the configuration for indexing Confluence spaces.
", + "refs": { + "ConfluenceConfiguration$SpaceConfiguration": "Specifies configuration information for indexing Confluence spaces.
" + } + }, + "ConfluenceSpaceFieldMappingsList": { + "base": null, + "refs": { + "ConfluenceSpaceConfiguration$SpaceFieldMappings": "Defines how space metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex operation.
If you specify the SpaceFieldMappings parameter, you must specify at least one field mapping.
The name of the field in the data source.
" + } + }, + "ConfluenceSpaceIdentifier": { + "base": null, + "refs": { + "ConfluenceSpaceList$member": null + } + }, + "ConfluenceSpaceList": { + "base": null, + "refs": { + "ConfluenceSpaceConfiguration$IncludeSpaces": "A list of space keys for Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are indexed. Spaces that aren't in the list aren't indexed. A space in the list must exist. Otherwise, Amazon Kendra logs an error when the data source is synchronized. If a space is in both the IncludeSpaces and the ExcludeSpaces list, the space is excluded.
A list of space keys of Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are not indexed. If a space is in both the ExcludeSpaces and the IncludeSpaces list, the space is excluded.
Defines the mapping between a field in the Confluence data source to a Amazon Kendra index field.
You must first create the index field using the operation.
", + "refs": { + "ConfluenceSpaceFieldMappingsList$member": null + } + }, + "ConfluenceVersion": { + "base": null, + "refs": { + "ConfluenceConfiguration$Version": "Specifies the version of the Confluence installation that you are connecting to.
" + } + }, "ConnectionConfiguration": { "base": "Provides the information necessary to connect to a database.
", "refs": { @@ -264,6 +388,10 @@ "DataSourceDateFieldFormat": { "base": null, "refs": { + "ConfluenceAttachmentToIndexFieldMapping$DateFieldFormat": "The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.
The type of data stored in the column or attribute.
" } }, @@ -305,6 +433,8 @@ "DataSourceInclusionsExclusionsStrings": { "base": null, "refs": { + "ConfluenceConfiguration$InclusionPatterns": "A list of regular expression patterns that apply to a URL on the Confluence server. An inclusion pattern can apply to a blog post, a page, a space, or an attachment. Items that match the patterns are included in the index. Items that don't match the pattern are excluded from the index. If an item matches both an inclusion pattern and an exclusion pattern, the item isn't included in the index.
", + "ConfluenceConfiguration$ExclusionPatterns": "A list of regular expression patterns that apply to a URL on the Confluence server. An exclusion pattern can apply to a blog post, a page, a space, or an attachment. Items that match the pattern are excluded from the index. Items that don't match the pattern are included in the index. If a item matches both an exclusion pattern and an inclusion pattern, the item isn't included in the index.
", "OneDriveConfiguration$InclusionPatterns": "A list of regular expression patterns. Documents that match the pattern are included in the index. Documents that don't match the pattern are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.
The exclusion pattern is applied to the file name.
", "OneDriveConfiguration$ExclusionPatterns": "List of regular expressions applied to documents. Items that match the exclusion pattern are not indexed. If you provide both an inclusion pattern and an exclusion pattern, any item that matches the exclusion pattern isn't indexed.
The exclusion pattern is applied to the file name.
", "S3DataSourceConfiguration$InclusionPrefixes": "A list of S3 prefixes for the documents that should be included in the index.
", @@ -423,6 +553,7 @@ "DataSourceVpcConfiguration": { "base": "Provides information for connecting to an Amazon VPC.
", "refs": { + "ConfluenceConfiguration$VpcConfiguration": "Specifies the information for connecting to an Amazon VPC.
", "DatabaseConfiguration$VpcConfiguration": null, "SharePointConfiguration$VpcConfiguration": null } @@ -800,6 +931,10 @@ "IndexFieldName": { "base": null, "refs": { + "ConfluenceAttachmentToIndexFieldMapping$IndexFieldName": "The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.
", + "ConfluenceBlogToIndexFieldMapping$IndexFieldName": "The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.
", + "ConfluencePageToIndexFieldMapping$IndexFieldName": "The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.
", + "ConfluenceSpaceToIndexFieldMapping$IndexFieldName": "The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.
", "DataSourceToIndexFieldMapping$IndexFieldName": "The name of the field in the index.
" } }, @@ -1326,6 +1461,7 @@ "SecretArn": { "base": null, "refs": { + "ConfluenceConfiguration$SecretArn": "The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key/value pairs required to connect to your Confluence server. The secret must contain a JSON structure with the following keys:
username - The user name of a user with administrative privileges for the Confluence server.
password - The password associated with the user logging in to the Confluence server.
The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Database Data Source. For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.
", "OneDriveConfiguration$SecretArn": "The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the user name and password to connect to OneDrive. The user namd should be the application ID for the OneDrive application, and the password is the application key for the OneDrive application.
", "SalesforceConfiguration$SecretArn": "The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key/value pairs required to connect to your Salesforce instance. The secret must contain a JSON structure with the following keys:
authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token.
consumerKey - The application public key generated when you created your Salesforce application.
consumerSecret - The application private key generated when you created your Salesforce application.
password - The password associated with the user logging in to the Salesforce instance.
securityToken - The token associated with the user account logging in to the Salesforce instance.
username - The user name of the user logging in to the Salesforce instance.
The URL of your Confluence instance. Use the full URL of the server. For example, https://server.example.com:port/. You can also use an IP address, for example, https://192.168.1.113/.
The URI of the original location of the document.
", "SalesforceConfiguration$ServerUrl": "The instance URL for the Salesforce site that you want to index.
", "SharePointUrlList$member": null diff --git a/aws-sdk-core/apis/neptune/2014-10-31/api-2.json b/aws-sdk-core/apis/neptune/2014-10-31/api-2.json index c2b773b8924..f25c453f80c 100644 --- a/aws-sdk-core/apis/neptune/2014-10-31/api-2.json +++ b/aws-sdk-core/apis/neptune/2014-10-31/api-2.json @@ -154,6 +154,26 @@ {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"} ] }, + "CreateDBClusterEndpoint":{ + "name":"CreateDBClusterEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBClusterEndpointMessage"}, + "output":{ + "shape":"CreateDBClusterEndpointOutput", + "resultWrapper":"CreateDBClusterEndpointResult" + }, + "errors":[ + {"shape":"DBClusterEndpointQuotaExceededFault"}, + {"shape":"DBClusterEndpointAlreadyExistsFault"}, + {"shape":"DBClusterNotFoundFault"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"InvalidDBInstanceStateFault"} + ] + }, "CreateDBClusterParameterGroup":{ "name":"CreateDBClusterParameterGroup", "http":{ @@ -296,6 +316,23 @@ {"shape":"InvalidDBClusterSnapshotStateFault"} ] }, + "DeleteDBClusterEndpoint":{ + "name":"DeleteDBClusterEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBClusterEndpointMessage"}, + "output":{ + "shape":"DeleteDBClusterEndpointOutput", + "resultWrapper":"DeleteDBClusterEndpointResult" + }, + "errors":[ + {"shape":"InvalidDBClusterEndpointStateFault"}, + {"shape":"DBClusterEndpointNotFoundFault"}, + {"shape":"InvalidDBClusterStateFault"} + ] + }, "DeleteDBClusterParameterGroup":{ "name":"DeleteDBClusterParameterGroup", "http":{ @@ -384,6 +421,21 @@ {"shape":"InvalidEventSubscriptionStateFault"} ] }, + "DescribeDBClusterEndpoints":{ + "name":"DescribeDBClusterEndpoints", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBClusterEndpointsMessage"}, + "output":{ + "shape":"DBClusterEndpointMessage", + "resultWrapper":"DescribeDBClusterEndpointsResult" + }, + "errors":[ + {"shape":"DBClusterNotFoundFault"} + ] + }, "DescribeDBClusterParameterGroups":{ "name":"DescribeDBClusterParameterGroups", "http":{ @@ -696,6 +748,25 @@ {"shape":"DBClusterAlreadyExistsFault"} ] }, + "ModifyDBClusterEndpoint":{ + "name":"ModifyDBClusterEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyDBClusterEndpointMessage"}, + "output":{ + "shape":"ModifyDBClusterEndpointOutput", + "resultWrapper":"ModifyDBClusterEndpointResult" + }, + "errors":[ + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"InvalidDBClusterEndpointStateFault"}, + {"shape":"DBClusterEndpointNotFoundFault"}, + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"InvalidDBInstanceStateFault"} + ] + }, "ModifyDBClusterParameterGroup":{ "name":"ModifyDBClusterParameterGroup", "http":{ @@ -1027,7 +1098,8 @@ ], "members":{ "DBClusterIdentifier":{"shape":"String"}, - "RoleArn":{"shape":"String"} + "RoleArn":{"shape":"String"}, + "FeatureName":{"shape":"String"} } }, "AddSourceIdentifierToSubscriptionMessage":{ @@ -1211,6 +1283,37 @@ "DBParameterGroup":{"shape":"DBParameterGroup"} } }, + "CreateDBClusterEndpointMessage":{ + "type":"structure", + "required":[ + "DBClusterIdentifier", + "DBClusterEndpointIdentifier", + "EndpointType" + ], + "members":{ + "DBClusterIdentifier":{"shape":"String"}, + "DBClusterEndpointIdentifier":{"shape":"String"}, + "EndpointType":{"shape":"String"}, + "StaticMembers":{"shape":"StringList"}, + "ExcludedMembers":{"shape":"StringList"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateDBClusterEndpointOutput":{ + "type":"structure", + "members":{ + "DBClusterEndpointIdentifier":{"shape":"String"}, + "DBClusterIdentifier":{"shape":"String"}, + "DBClusterEndpointResourceIdentifier":{"shape":"String"}, + "Endpoint":{"shape":"String"}, + "Status":{"shape":"String"}, + "EndpointType":{"shape":"String"}, + "CustomEndpointType":{"shape":"String"}, + "StaticMembers":{"shape":"StringList"}, + "ExcludedMembers":{"shape":"StringList"}, + "DBClusterEndpointArn":{"shape":"String"} + } + }, "CreateDBClusterMessage":{ "type":"structure", "required":[ @@ -1466,6 +1569,68 @@ }, "exception":true }, + "DBClusterEndpoint":{ + "type":"structure", + "members":{ + "DBClusterEndpointIdentifier":{"shape":"String"}, + "DBClusterIdentifier":{"shape":"String"}, + "DBClusterEndpointResourceIdentifier":{"shape":"String"}, + "Endpoint":{"shape":"String"}, + "Status":{"shape":"String"}, + "EndpointType":{"shape":"String"}, + "CustomEndpointType":{"shape":"String"}, + "StaticMembers":{"shape":"StringList"}, + "ExcludedMembers":{"shape":"StringList"}, + "DBClusterEndpointArn":{"shape":"String"} + } + }, + "DBClusterEndpointAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBClusterEndpointAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBClusterEndpointList":{ + "type":"list", + "member":{ + "shape":"DBClusterEndpoint", + "locationName":"DBClusterEndpointList" + } + }, + "DBClusterEndpointMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "DBClusterEndpoints":{"shape":"DBClusterEndpointList"} + } + }, + "DBClusterEndpointNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBClusterEndpointNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBClusterEndpointQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBClusterEndpointQuotaExceededFault", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, "DBClusterList":{ "type":"list", "member":{ @@ -1585,7 +1750,8 @@ "type":"structure", "members":{ "RoleArn":{"shape":"String"}, - "Status":{"shape":"String"} + "Status":{"shape":"String"}, + "FeatureName":{"shape":"String"} } }, "DBClusterRoleAlreadyExistsFault":{ @@ -2087,6 +2253,28 @@ }, "exception":true }, + "DeleteDBClusterEndpointMessage":{ + "type":"structure", + "required":["DBClusterEndpointIdentifier"], + "members":{ + "DBClusterEndpointIdentifier":{"shape":"String"} + } + }, + "DeleteDBClusterEndpointOutput":{ + "type":"structure", + "members":{ + "DBClusterEndpointIdentifier":{"shape":"String"}, + "DBClusterIdentifier":{"shape":"String"}, + "DBClusterEndpointResourceIdentifier":{"shape":"String"}, + "Endpoint":{"shape":"String"}, + "Status":{"shape":"String"}, + "EndpointType":{"shape":"String"}, + "CustomEndpointType":{"shape":"String"}, + "StaticMembers":{"shape":"StringList"}, + "ExcludedMembers":{"shape":"StringList"}, + "DBClusterEndpointArn":{"shape":"String"} + } + }, "DeleteDBClusterMessage":{ "type":"structure", "required":["DBClusterIdentifier"], @@ -2164,6 +2352,16 @@ "EventSubscription":{"shape":"EventSubscription"} } }, + "DescribeDBClusterEndpointsMessage":{ + "type":"structure", + "members":{ + "DBClusterIdentifier":{"shape":"String"}, + "DBClusterEndpointIdentifier":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, "DescribeDBClusterParameterGroupsMessage":{ "type":"structure", "members":{ @@ -2607,6 +2805,17 @@ }, "Integer":{"type":"integer"}, "IntegerOptional":{"type":"integer"}, + "InvalidDBClusterEndpointStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBClusterEndpointStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, "InvalidDBClusterSnapshotStateFault":{ "type":"structure", "members":{ @@ -2766,6 +2975,31 @@ "type":"list", "member":{"shape":"String"} }, + "ModifyDBClusterEndpointMessage":{ + "type":"structure", + "required":["DBClusterEndpointIdentifier"], + "members":{ + "DBClusterEndpointIdentifier":{"shape":"String"}, + "EndpointType":{"shape":"String"}, + "StaticMembers":{"shape":"StringList"}, + "ExcludedMembers":{"shape":"StringList"} + } + }, + "ModifyDBClusterEndpointOutput":{ + "type":"structure", + "members":{ + "DBClusterEndpointIdentifier":{"shape":"String"}, + "DBClusterIdentifier":{"shape":"String"}, + "DBClusterEndpointResourceIdentifier":{"shape":"String"}, + "Endpoint":{"shape":"String"}, + "Status":{"shape":"String"}, + "EndpointType":{"shape":"String"}, + "CustomEndpointType":{"shape":"String"}, + "StaticMembers":{"shape":"StringList"}, + "ExcludedMembers":{"shape":"StringList"}, + "DBClusterEndpointArn":{"shape":"String"} + } + }, "ModifyDBClusterMessage":{ "type":"structure", "required":["DBClusterIdentifier"], @@ -3148,7 +3382,8 @@ ], "members":{ "DBClusterIdentifier":{"shape":"String"}, - "RoleArn":{"shape":"String"} + "RoleArn":{"shape":"String"}, + "FeatureName":{"shape":"String"} } }, "RemoveSourceIdentifierFromSubscriptionMessage":{ @@ -3411,6 +3646,10 @@ "exception":true }, "String":{"type":"string"}, + "StringList":{ + "type":"list", + "member":{"shape":"String"} + }, "Subnet":{ "type":"structure", "members":{ diff --git a/aws-sdk-core/apis/neptune/2014-10-31/docs-2.json b/aws-sdk-core/apis/neptune/2014-10-31/docs-2.json index 9a6e014c6e3..ea63b4df8e1 100644 --- a/aws-sdk-core/apis/neptune/2014-10-31/docs-2.json +++ b/aws-sdk-core/apis/neptune/2014-10-31/docs-2.json @@ -10,6 +10,7 @@ "CopyDBClusterSnapshot": "Copies a snapshot of a DB cluster.
To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.
Copies the specified DB parameter group.
", "CreateDBCluster": "Creates a new Amazon Neptune DB cluster.
You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a Read Replica of another DB cluster or Amazon Neptune DB instance.
Note that when you create a new cluster using CreateDBCluster directly, deletion protection is disabled by default (when you create a new production cluster in the console, deletion protection is enabled by default). You can only delete a DB cluster if its DeletionProtection field is set to false.
Creates a new custom endpoint and associates it with an Amazon Neptune DB cluster.
", "CreateDBClusterParameterGroup": "Creates a new DB cluster parameter group.
Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.
A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.
After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.
Creates a snapshot of a DB cluster.
", "CreateDBInstance": "Creates a new DB instance.
", @@ -17,12 +18,14 @@ "CreateDBSubnetGroup": "Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.
", "CreateEventSubscription": "Creates an event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the Neptune console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.
You can specify the type of source (SourceType) you want to be notified of, provide a list of Neptune sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.
If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your Neptune sources. If you do not specify either the SourceType nor the SourceIdentifier, you are notified of events generated from all Neptune sources belonging to your customer account.
", "DeleteDBCluster": "The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.
Note that the DB Cluster cannot be deleted if deletion protection is enabled. To delete it, you must first set its DeletionProtection field to False.
Deletes a custom endpoint and removes it from an Amazon Neptune DB cluster.
", "DeleteDBClusterParameterGroup": "Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.
", "DeleteDBClusterSnapshot": "Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
The DB cluster snapshot must be in the available state to be deleted.
The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.
If you request a final DB snapshot the status of the Amazon Neptune DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.
Note that when a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when the SkipFinalSnapshot parameter is set to true.
You can't delete a DB instance if it is the only instance in the DB cluster, or if it has deletion protection enabled.
", "DeleteDBParameterGroup": "Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted can't be associated with any DB instances.
", "DeleteDBSubnetGroup": "Deletes a DB subnet group.
The specified database subnet group must not be associated with any DB instances.
Deletes an event notification subscription.
", + "DescribeDBClusterEndpoints": "Returns information about endpoints for an Amazon Neptune DB cluster.
This operation can also return information for Amazon RDS clusters and Amazon DocDB clusters.
Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group.
Returns the detailed parameter list for a particular DB cluster parameter group.
", "DescribeDBClusterSnapshotAttributes": "Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.
When sharing snapshots with other AWS accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all AWS accounts.
To add or remove access for an AWS account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.
", @@ -44,6 +47,7 @@ "FailoverDBCluster": "Forces a failover for a DB cluster.
A failover for a DB cluster promotes one of the Read Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer).
Amazon Neptune will automatically fail over to a Read Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.
", "ListTagsForResource": "Lists all tags on an Amazon Neptune resource.
", "ModifyDBCluster": "Modify a setting for a DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
", + "ModifyDBClusterEndpoint": "Modifies the properties of an endpoint in an Amazon Neptune DB cluster.
", "ModifyDBClusterParameterGroup": " Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.
Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect.
After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.
Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
To share a manual DB cluster snapshot with other AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all AWS accounts. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.
To view which AWS accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot public or private, use the DescribeDBClusterSnapshotAttributes API action.
", "ModifyDBInstance": "Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications before you call ModifyDBInstance.
", @@ -182,7 +186,7 @@ "refs": { "CopyDBClusterSnapshotMessage$CopyTags": "True to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot, and otherwise false. The default is false.
", "CreateDBClusterMessage$StorageEncrypted": "Specifies whether the DB cluster is encrypted.
", - "CreateDBClusterMessage$EnableIAMDatabaseAuthentication": "True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default: false
Not supported by Neptune.
", "CreateDBClusterMessage$DeletionProtection": "A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is enabled.
", "CreateDBInstanceMessage$MultiAZ": "Specifies if the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the MultiAZ parameter is set to true.
", "CreateDBInstanceMessage$AutoMinorVersionUpgrade": "Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.
Default: true
This data type represents the information you need to connect to an Amazon Neptune DB cluster. This data type is used as a response element in the following actions:
CreateDBClusterEndpoint
DescribeDBClusterEndpoints
ModifyDBClusterEndpoint
DeleteDBClusterEndpoint
For the data structure that represents Amazon Neptune DB instance endpoints, see Endpoint.
This data type represents the information you need to connect to an Amazon Neptune DB cluster. This data type is used as a response element in the following actions:
CreateDBClusterEndpoint
DescribeDBClusterEndpoints
ModifyDBClusterEndpoint
DeleteDBClusterEndpoint
For the data structure that represents Amazon Neptune DB instance endpoints, see Endpoint.
The specified custom endpoint cannot be created because it already exists.
", + "refs": { + } + }, + "DBClusterEndpointList": { + "base": null, + "refs": { + "DBClusterEndpointMessage$DBClusterEndpoints": "Contains the details of the endpoints associated with the cluster and matching any filter conditions.
" + } + }, + "DBClusterEndpointMessage": { + "base": null, + "refs": { + } + }, + "DBClusterEndpointNotFoundFault": { + "base": "The specified custom endpoint doesn't exist.
", + "refs": { + } + }, + "DBClusterEndpointQuotaExceededFault": { + "base": "The cluster already has the maximum number of custom endpoints.
", + "refs": { + } + }, "DBClusterList": { "base": null, "refs": { @@ -711,6 +757,16 @@ "refs": { } }, + "DeleteDBClusterEndpointMessage": { + "base": null, + "refs": { + } + }, + "DeleteDBClusterEndpointOutput": { + "base": "This data type represents the information you need to connect to an Amazon Neptune DB cluster. This data type is used as a response element in the following actions:
CreateDBClusterEndpoint
DescribeDBClusterEndpoints
ModifyDBClusterEndpoint
DeleteDBClusterEndpoint
For the data structure that represents Amazon RDS DB instance endpoints, see Endpoint.
Specifies a connection endpoint.
", + "base": "Specifies a connection endpoint.
For the data structure that represents Amazon Neptune DB cluster endpoints, see DBClusterEndpoint.
Specifies the connection endpoint.
" } @@ -1023,6 +1084,7 @@ "FilterList": { "base": null, "refs": { + "DescribeDBClusterEndpointsMessage$Filters": "A set of name-value pairs that define which endpoints to include in the output. The filters are specified as name-value pairs, in the format Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... Name can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type, db-cluster-endpoint-id, db-cluster-endpoint-status. Values for the db-cluster-endpoint-type filter can be one or more of: reader, writer, custom. Values for the db-cluster-endpoint-custom-type filter can be one or more of: reader, any. Values for the db-cluster-endpoint-status filter can be one or more of: available, creating, deleting, inactive, modifying.
This parameter is not currently supported.
", "DescribeDBClusterParametersMessage$Filters": "This parameter is not currently supported.
", "DescribeDBClusterSnapshotsMessage$Filters": "This parameter is not currently supported.
", @@ -1100,6 +1162,7 @@ "DBInstance$Iops": "Specifies the Provisioned IOPS (I/O operations per second) value.
", "DBInstance$MonitoringInterval": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
", "DBInstance$PromotionTier": "A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.
", + "DescribeDBClusterEndpointsMessage$MaxRecords": "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
", "DescribeDBClusterParameterGroupsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
", "DescribeDBClusterParametersMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
", "DescribeDBClusterSnapshotsMessage$MaxRecords": "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
", @@ -1137,6 +1200,11 @@ "RestoreDBClusterToPointInTimeMessage$Port": "The port number on which the new DB cluster accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB cluster.
" } }, + "InvalidDBClusterEndpointStateFault": { + "base": "The requested operation cannot be performed on the endpoint while the endpoint is in this state.
", + "refs": { + } + }, "InvalidDBClusterSnapshotStateFault": { "base": "The supplied value is not a valid DB cluster snapshot state.
", "refs": { @@ -1229,6 +1297,16 @@ "RestoreDBClusterToPointInTimeMessage$EnableCloudwatchLogsExports": "The list of logs that the restored DB cluster is to export to CloudWatch Logs.
" } }, + "ModifyDBClusterEndpointMessage": { + "base": null, + "refs": { + } + }, + "ModifyDBClusterEndpointOutput": { + "base": "This data type represents the information you need to connect to an Amazon Aurora DB cluster. This data type is used as a response element in the following actions:
CreateDBClusterEndpoint
DescribeDBClusterEndpoints
ModifyDBClusterEndpoint
DeleteDBClusterEndpoint
For the data structure that represents Amazon RDS DB instance endpoints, see Endpoint.
The name of the DB cluster to associate the IAM role with.
", "AddRoleToDBClusterMessage$RoleArn": "The Amazon Resource Name (ARN) of the IAM role to associate with the Neptune DB cluster, for example arn:aws:iam::123456789012:role/NeptuneAccessRole.
The name of the feature for the Neptune DB cluster that the IAM role is to be associated with. For the list of supported feature names, see DBEngineVersion.
", "AddSourceIdentifierToSubscriptionMessage$SubscriptionName": "The name of the event notification subscription you want to add a source identifier to.
", "AddSourceIdentifierToSubscriptionMessage$SourceIdentifier": "The identifier of the event source to be added.
Constraints:
If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.
If the source type is a DB security group, a DBSecurityGroupName must be supplied.
If the source type is a DB parameter group, a DBParameterGroupName must be supplied.
If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.
The Amazon Neptune resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an Amazon Resource Name (ARN).
", @@ -1594,13 +1673,24 @@ "CopyDBParameterGroupMessage$SourceDBParameterGroupIdentifier": "The identifier or ARN for the source DB parameter group. For information about creating an ARN, see Constructing an Amazon Resource Name (ARN).
Constraints:
Must specify a valid DB parameter group.
Must specify a valid DB parameter group identifier, for example my-db-param-group, or a valid ARN.
The identifier for the copied DB parameter group.
Constraints:
Cannot be null, empty, or blank.
Must contain from 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-db-parameter-group
A description for the copied DB parameter group.
", + "CreateDBClusterEndpointMessage$DBClusterIdentifier": "The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
", + "CreateDBClusterEndpointMessage$DBClusterEndpointIdentifier": "The identifier to use for the new endpoint. This parameter is stored as a lowercase string.
", + "CreateDBClusterEndpointMessage$EndpointType": "The type of the endpoint. One of: READER, WRITER, ANY.
The identifier associated with the endpoint. This parameter is stored as a lowercase string.
", + "CreateDBClusterEndpointOutput$DBClusterIdentifier": "The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
", + "CreateDBClusterEndpointOutput$DBClusterEndpointResourceIdentifier": "A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
", + "CreateDBClusterEndpointOutput$Endpoint": "The DNS address of the endpoint.
", + "CreateDBClusterEndpointOutput$Status": "The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that cannot be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.
The type of the endpoint. One of: READER, WRITER, CUSTOM.
The type associated with a custom endpoint. One of: READER, WRITER, ANY.
The Amazon Resource Name (ARN) for the endpoint.
", "CreateDBClusterMessage$CharacterSetName": "(Not supported by Neptune)
", "CreateDBClusterMessage$DatabaseName": "The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon Neptune will not create a database in the DB cluster you are creating.
", "CreateDBClusterMessage$DBClusterIdentifier": "The DB cluster identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default is used.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
A DB subnet group to associate with this DB cluster.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mySubnetgroup
The name of the database engine to be used for this DB cluster.
Valid Values: neptune
The version number of the database engine to use. Currently, setting this parameter has no effect.
Example: 1.0.1
The version number of the database engine to use for the new DB cluster.
Example: 1.0.2.1
The name of the master user for the DB cluster.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Cannot be a reserved word for the chosen database engine.
The password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".
Constraints: Must contain from 8 to 41 characters.
", "CreateDBClusterMessage$OptionGroupName": "(Not supported by Neptune)
", @@ -1667,6 +1757,15 @@ "DBCluster$DbClusterResourceId": "The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
", "DBCluster$DBClusterArn": "The Amazon Resource Name (ARN) for the DB cluster.
", "DBCluster$CloneGroupId": "Identifies the clone group to which the DB cluster is associated.
", + "DBClusterEndpoint$DBClusterEndpointIdentifier": "The identifier associated with the endpoint. This parameter is stored as a lowercase string.
", + "DBClusterEndpoint$DBClusterIdentifier": "The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
", + "DBClusterEndpoint$DBClusterEndpointResourceIdentifier": "A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
", + "DBClusterEndpoint$Endpoint": "The DNS address of the endpoint.
", + "DBClusterEndpoint$Status": "The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that cannot be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.
The type of the endpoint. One of: READER, WRITER, CUSTOM.
The type associated with a custom endpoint. One of: READER, WRITER, ANY.
The Amazon Resource Name (ARN) for the endpoint.
", + "DBClusterEndpointMessage$Marker": " An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Specifies the instance identifier for this member of the DB cluster.
", "DBClusterMember$DBClusterParameterGroupStatus": "Specifies the status of the DB cluster parameter group for this member of the DB cluster.
", "DBClusterMessage$Marker": "A pagination token that can be used in a subsequent DescribeDBClusters request.
", @@ -1681,6 +1780,7 @@ "DBClusterParameterGroupsMessage$Marker": " An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
", "DBClusterRole$Status": "Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other AWS services on your behalf.
PENDING - the IAM role ARN is being associated with the DB cluster.
INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other AWS services on your behalf.
The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion.
", "DBClusterSnapshot$DBClusterSnapshotIdentifier": "Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.
After you restore a DB cluster using a DBClusterSnapshotIdentifier, you must specify the same DBClusterSnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.
However, if you don't specify the DBClusterSnapshotIdentifier, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the DBClusterSnapshotIdentifier, and the original DB cluster is deleted.
Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
", "DBClusterSnapshot$Engine": "Specifies the name of the database engine.
", @@ -1749,6 +1849,15 @@ "DBSubnetGroup$SubnetGroupStatus": "Provides the status of the DB subnet group.
", "DBSubnetGroup$DBSubnetGroupArn": "The Amazon Resource Name (ARN) for the DB subnet group.
", "DBSubnetGroupMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The identifier associated with the custom endpoint. This parameter is stored as a lowercase string.
", + "DeleteDBClusterEndpointOutput$DBClusterEndpointIdentifier": "The identifier associated with the endpoint. This parameter is stored as a lowercase string.
", + "DeleteDBClusterEndpointOutput$DBClusterIdentifier": "The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
", + "DeleteDBClusterEndpointOutput$DBClusterEndpointResourceIdentifier": "A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
", + "DeleteDBClusterEndpointOutput$Endpoint": "The DNS address of the endpoint.
", + "DeleteDBClusterEndpointOutput$Status": "The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that cannot be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.
The type of the endpoint. One of: READER, WRITER, CUSTOM.
The type associated with a custom endpoint. One of: READER, WRITER, ANY.
The Amazon Resource Name (ARN) for the endpoint.
", "DeleteDBClusterMessage$DBClusterIdentifier": "The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive.
Constraints:
Must match an existing DBClusterIdentifier.
The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is set to false.
Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
The name of the DB cluster parameter group.
Constraints:
Must be the name of an existing DB cluster parameter group.
You can't delete a default DB cluster parameter group.
Cannot be associated with any DB clusters.
The name of the DB parameter group.
Constraints:
Must be the name of an existing DB parameter group
You can't delete a default DB parameter group
Cannot be associated with any DB instances
The name of the database subnet group to delete.
You can't delete the default subnet group.
Constraints:
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mySubnetgroup
The name of the event notification subscription you want to delete.
", + "DescribeDBClusterEndpointsMessage$DBClusterIdentifier": "The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
", + "DescribeDBClusterEndpointsMessage$DBClusterEndpointIdentifier": "The identifier of the endpoint to describe. This parameter is stored as a lowercase string.
", + "DescribeDBClusterEndpointsMessage$Marker": " An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of a specific DB cluster parameter group to return details for.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of a specific DB cluster parameter group to return parameter details for.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
The Amazon Neptune resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an Amazon Resource Name (ARN).
", "LogTypeList$member": null, + "ModifyDBClusterEndpointMessage$DBClusterEndpointIdentifier": "The identifier of the endpoint to modify. This parameter is stored as a lowercase string.
", + "ModifyDBClusterEndpointMessage$EndpointType": "The type of the endpoint. One of: READER, WRITER, ANY.
The identifier associated with the endpoint. This parameter is stored as a lowercase string.
", + "ModifyDBClusterEndpointOutput$DBClusterIdentifier": "The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
", + "ModifyDBClusterEndpointOutput$DBClusterEndpointResourceIdentifier": "A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
", + "ModifyDBClusterEndpointOutput$Endpoint": "The DNS address of the endpoint.
", + "ModifyDBClusterEndpointOutput$Status": "The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that cannot be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.
The type of the endpoint. One of: READER, WRITER, CUSTOM.
The type associated with a custom endpoint. One of: READER, WRITER, ANY.
The Amazon Resource Name (ARN) for the endpoint.
", "ModifyDBClusterMessage$DBClusterIdentifier": "The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive.
Constraints:
Must match the identifier of an existing DBCluster.
The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
The first character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-cluster2
The name of the DB cluster parameter group to use for the DB cluster.
", @@ -1836,7 +1958,7 @@ "ModifyDBClusterMessage$OptionGroupName": "(Not supported by Neptune)
", "ModifyDBClusterMessage$PreferredBackupWindow": "The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region.
Constraints:
Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
", - "ModifyDBClusterMessage$EngineVersion": "The version number of the database engine. Currently, setting this parameter has no effect. To upgrade your database engine to the most recent release, use the ApplyPendingMaintenanceAction API.
For a list of valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.
", + "ModifyDBClusterMessage$EngineVersion": "The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true.
For a list of valid engine versions, see Engine Releases for Amazon Neptune, or call DescribeDBEngineVersions.
", "ModifyDBClusterParameterGroupMessage$DBClusterParameterGroupName": "The name of the DB cluster parameter group to modify.
", "ModifyDBClusterSnapshotAttributeMessage$DBClusterSnapshotIdentifier": "The identifier for the DB cluster snapshot to modify the attributes for.
", "ModifyDBClusterSnapshotAttributeMessage$AttributeName": "The name of the DB cluster snapshot attribute to modify.
To manage authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this value to restore.
The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DBInstance.
The name of the DB cluster to disassociate the IAM role from.
", "RemoveRoleFromDBClusterMessage$RoleArn": "The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB cluster, for example arn:aws:iam::123456789012:role/NeptuneAccessRole.
The name of the feature for the DB cluster that the IAM role is to be disassociated from. For the list of supported feature names, see DBEngineVersion.
", "RemoveSourceIdentifierFromSubscriptionMessage$SubscriptionName": "The name of the event notification subscription you want to remove a source identifier from.
", "RemoveSourceIdentifierFromSubscriptionMessage$SourceIdentifier": "The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group.
", "RemoveTagsFromResourceMessage$ResourceName": "The Amazon Neptune resource that the tags are removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an Amazon Resource Name (ARN).
", @@ -1925,6 +2048,7 @@ "SourceIdsList$member": null, "StartDBClusterMessage$DBClusterIdentifier": "The DB cluster identifier of the Neptune DB cluster to be started. This parameter is stored as a lowercase string.
", "StopDBClusterMessage$DBClusterIdentifier": "The DB cluster identifier of the Neptune DB cluster to be stopped. This parameter is stored as a lowercase string.
", + "StringList$member": null, "Subnet$SubnetIdentifier": "Specifies the identifier of the subnet.
", "Subnet$SubnetStatus": "Specifies the status of the subnet.
", "SubnetIdentifierList$member": null, @@ -1940,6 +2064,23 @@ "VpcSecurityGroupMembership$Status": "The status of the VPC security group.
" } }, + "StringList": { + "base": null, + "refs": { + "CreateDBClusterEndpointMessage$StaticMembers": "List of DB instance identifiers that are part of the custom endpoint group.
", + "CreateDBClusterEndpointMessage$ExcludedMembers": "List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
", + "CreateDBClusterEndpointOutput$StaticMembers": "List of DB instance identifiers that are part of the custom endpoint group.
", + "CreateDBClusterEndpointOutput$ExcludedMembers": "List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
", + "DBClusterEndpoint$StaticMembers": "List of DB instance identifiers that are part of the custom endpoint group.
", + "DBClusterEndpoint$ExcludedMembers": "List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
", + "DeleteDBClusterEndpointOutput$StaticMembers": "List of DB instance identifiers that are part of the custom endpoint group.
", + "DeleteDBClusterEndpointOutput$ExcludedMembers": "List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
", + "ModifyDBClusterEndpointMessage$StaticMembers": "List of DB instance identifiers that are part of the custom endpoint group.
", + "ModifyDBClusterEndpointMessage$ExcludedMembers": "List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
", + "ModifyDBClusterEndpointOutput$StaticMembers": "List of DB instance identifiers that are part of the custom endpoint group.
", + "ModifyDBClusterEndpointOutput$ExcludedMembers": "List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
" + } + }, "Subnet": { "base": "Specifies a subnet.
This data type is used as a response element in the DescribeDBSubnetGroups action.
", "refs": { @@ -2023,6 +2164,7 @@ "CopyDBClusterParameterGroupMessage$Tags": "The tags to be assigned to the copied DB cluster parameter group.
", "CopyDBClusterSnapshotMessage$Tags": "The tags to assign to the new DB cluster snapshot copy.
", "CopyDBParameterGroupMessage$Tags": "The tags to be assigned to the copied DB parameter group.
", + "CreateDBClusterEndpointMessage$Tags": "The tags to be assigned to the Amazon Neptune resource.
", "CreateDBClusterMessage$Tags": "The tags to assign to the new DB cluster.
", "CreateDBClusterParameterGroupMessage$Tags": "The tags to be assigned to the new DB cluster parameter group.
", "CreateDBClusterSnapshotMessage$Tags": "The tags to be assigned to the DB cluster snapshot.
", diff --git a/aws-sdk-core/apis/neptune/2014-10-31/paginators-1.json b/aws-sdk-core/apis/neptune/2014-10-31/paginators-1.json index 2a4588640a8..fddbddd2e11 100644 --- a/aws-sdk-core/apis/neptune/2014-10-31/paginators-1.json +++ b/aws-sdk-core/apis/neptune/2014-10-31/paginators-1.json @@ -1,5 +1,11 @@ { "pagination": { + "DescribeDBClusterEndpoints": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBClusterEndpoints" + }, "DescribeDBEngineVersions": { "input_token": "Marker", "limit_key": "MaxRecords", diff --git a/aws-sdk-core/apis/sagemaker/2017-07-24/api-2.json b/aws-sdk-core/apis/sagemaker/2017-07-24/api-2.json index a2b9aa7064a..7f6ac0d1b07 100644 --- a/aws-sdk-core/apis/sagemaker/2017-07-24/api-2.json +++ b/aws-sdk-core/apis/sagemaker/2017-07-24/api-2.json @@ -58,6 +58,18 @@ {"shape":"ResourceInUse"} ] }, + "CreateAppImageConfig":{ + "name":"CreateAppImageConfig", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAppImageConfigRequest"}, + "output":{"shape":"CreateAppImageConfigResponse"}, + "errors":[ + {"shape":"ResourceInUse"} + ] + }, "CreateAutoMLJob":{ "name":"CreateAutoMLJob", "http":{ @@ -181,6 +193,33 @@ {"shape":"ResourceLimitExceeded"} ] }, + "CreateImage":{ + "name":"CreateImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateImageRequest"}, + "output":{"shape":"CreateImageResponse"}, + "errors":[ + {"shape":"ResourceInUse"}, + {"shape":"ResourceLimitExceeded"} + ] + }, + "CreateImageVersion":{ + "name":"CreateImageVersion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateImageVersionRequest"}, + "output":{"shape":"CreateImageVersionResponse"}, + "errors":[ + {"shape":"ResourceInUse"}, + {"shape":"ResourceLimitExceeded"}, + {"shape":"ResourceNotFound"} + ] + }, "CreateLabelingJob":{ "name":"CreateLabelingJob", "http":{ @@ -213,7 +252,11 @@ "requestUri":"/" }, "input":{"shape":"CreateModelPackageInput"}, - "output":{"shape":"CreateModelPackageOutput"} + "output":{"shape":"CreateModelPackageOutput"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ResourceLimitExceeded"} + ] }, "CreateMonitoringSchedule":{ "name":"CreateMonitoringSchedule", @@ -395,6 +438,17 @@ {"shape":"ResourceNotFound"} ] }, + "DeleteAppImageConfig":{ + "name":"DeleteAppImageConfig", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAppImageConfigRequest"}, + "errors":[ + {"shape":"ResourceNotFound"} + ] + }, "DeleteCodeRepository":{ "name":"DeleteCodeRepository", "http":{ @@ -468,6 +522,32 @@ {"shape":"ResourceNotFound"} ] }, + "DeleteImage":{ + "name":"DeleteImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteImageRequest"}, + "output":{"shape":"DeleteImageResponse"}, + "errors":[ + {"shape":"ResourceInUse"}, + {"shape":"ResourceNotFound"} + ] + }, + "DeleteImageVersion":{ + "name":"DeleteImageVersion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteImageVersionRequest"}, + "output":{"shape":"DeleteImageVersionResponse"}, + "errors":[ + {"shape":"ResourceInUse"}, + {"shape":"ResourceNotFound"} + ] + }, "DeleteModel":{ "name":"DeleteModel", "http":{ @@ -482,7 +562,10 @@ "method":"POST", "requestUri":"/" }, - "input":{"shape":"DeleteModelPackageInput"} + "input":{"shape":"DeleteModelPackageInput"}, + "errors":[ + {"shape":"ConflictException"} + ] }, "DeleteMonitoringSchedule":{ "name":"DeleteMonitoringSchedule", @@ -598,6 +681,18 @@ {"shape":"ResourceNotFound"} ] }, + "DescribeAppImageConfig":{ + "name":"DescribeAppImageConfig", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAppImageConfigRequest"}, + "output":{"shape":"DescribeAppImageConfigResponse"}, + "errors":[ + {"shape":"ResourceNotFound"} + ] + }, "DescribeAutoMLJob":{ "name":"DescribeAutoMLJob", "http":{ @@ -709,6 +804,30 @@ {"shape":"ResourceNotFound"} ] }, + "DescribeImage":{ + "name":"DescribeImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeImageRequest"}, + "output":{"shape":"DescribeImageResponse"}, + "errors":[ + {"shape":"ResourceNotFound"} + ] + }, + "DescribeImageVersion":{ + "name":"DescribeImageVersion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeImageVersionRequest"}, + "output":{"shape":"DescribeImageVersionResponse"}, + "errors":[ + {"shape":"ResourceNotFound"} + ] + }, "DescribeLabelingJob":{ "name":"DescribeLabelingJob", "http":{ @@ -898,6 +1017,15 @@ "input":{"shape":"ListAlgorithmsInput"}, "output":{"shape":"ListAlgorithmsOutput"} }, + "ListAppImageConfigs":{ + "name":"ListAppImageConfigs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAppImageConfigsRequest"}, + "output":{"shape":"ListAppImageConfigsResponse"} + }, "ListApps":{ "name":"ListApps", "http":{ @@ -1009,6 +1137,27 @@ "input":{"shape":"ListHyperParameterTuningJobsRequest"}, "output":{"shape":"ListHyperParameterTuningJobsResponse"} }, + "ListImageVersions":{ + "name":"ListImageVersions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListImageVersionsRequest"}, + "output":{"shape":"ListImageVersionsResponse"}, + "errors":[ + {"shape":"ResourceNotFound"} + ] + }, + "ListImages":{ + "name":"ListImages", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListImagesRequest"}, + "output":{"shape":"ListImagesResponse"} + }, "ListLabelingJobs":{ "name":"ListLabelingJobs", "http":{ @@ -1331,6 +1480,18 @@ {"shape":"ResourceNotFound"} ] }, + "UpdateAppImageConfig":{ + "name":"UpdateAppImageConfig", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateAppImageConfigRequest"}, + "output":{"shape":"UpdateAppImageConfigResponse"}, + "errors":[ + {"shape":"ResourceNotFound"} + ] + }, "UpdateCodeRepository":{ "name":"UpdateCodeRepository", "http":{ @@ -1391,6 +1552,19 @@ {"shape":"ResourceNotFound"} ] }, + "UpdateImage":{ + "name":"UpdateImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateImageRequest"}, + "output":{"shape":"UpdateImageResponse"}, + "errors":[ + {"shape":"ResourceInUse"}, + {"shape":"ResourceNotFound"} + ] + }, "UpdateMonitoringSchedule":{ "name":"UpdateMonitoringSchedule", "http":{ @@ -1656,6 +1830,38 @@ "CreationTime":{"shape":"CreationTime"} } }, + "AppImageConfigArn":{ + "type":"string", + "max":256, + "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:app-image-config/.*" + }, + "AppImageConfigDetails":{ + "type":"structure", + "members":{ + "AppImageConfigArn":{"shape":"AppImageConfigArn"}, + "AppImageConfigName":{"shape":"AppImageConfigName"}, + "CreationTime":{"shape":"Timestamp"}, + "LastModifiedTime":{"shape":"Timestamp"}, + "KernelGatewayImageConfig":{"shape":"KernelGatewayImageConfig"} + } + }, + "AppImageConfigList":{ + "type":"list", + "member":{"shape":"AppImageConfigDetails"} + }, + "AppImageConfigName":{ + "type":"string", + "max":63, + "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*" + }, + "AppImageConfigSortKey":{ + "type":"string", + "enum":[ + "CreationTime", + "LastModifiedTime", + "Name" + ] + }, "AppInstanceType":{ "type":"string", "enum":[ @@ -2263,6 +2469,12 @@ "pattern":"[\\w+=/-]+", "sensitive":true }, + "ClientToken":{ + "type":"string", + "max":36, + "min":1, + "pattern":"^[a-zA-Z0-9-]+$" + }, "CodeRepositoryArn":{ "type":"string", "max":2048, @@ -2427,8 +2639,8 @@ "CompilerOptions":{ "type":"string", "max":1024, - "min":7, - "pattern":"^\\{.+\\}$" + "min":3, + "pattern":".*" }, "CompressionType":{ "type":"string", @@ -2479,7 +2691,7 @@ "Mode":{"shape":"ContainerMode"}, "ModelDataUrl":{"shape":"Url"}, "Environment":{"shape":"EnvironmentMap"}, - "ModelPackageName":{"shape":"ArnOrName"} + "ModelPackageName":{"shape":"VersionedArnOrName"} } }, "ContainerDefinitionList":{ @@ -2589,6 +2801,21 @@ "AlgorithmArn":{"shape":"AlgorithmArn"} } }, + "CreateAppImageConfigRequest":{ + "type":"structure", + "required":["AppImageConfigName"], + "members":{ + "AppImageConfigName":{"shape":"AppImageConfigName"}, + "Tags":{"shape":"TagList"}, + "KernelGatewayImageConfig":{"shape":"KernelGatewayImageConfig"} + } + }, + "CreateAppImageConfigResponse":{ + "type":"structure", + "members":{ + "AppImageConfigArn":{"shape":"AppImageConfigArn"} + } + }, "CreateAppRequest":{ "type":"structure", "required":[ @@ -2671,7 +2898,8 @@ "RoleArn":{"shape":"RoleArn"}, "InputConfig":{"shape":"InputConfig"}, "OutputConfig":{"shape":"OutputConfig"}, - "StoppingCondition":{"shape":"StoppingCondition"} + "StoppingCondition":{"shape":"StoppingCondition"}, + "Tags":{"shape":"TagList"} } }, "CreateCompilationJobResponse":{ @@ -2697,8 +2925,8 @@ "SubnetIds":{"shape":"Subnets"}, "VpcId":{"shape":"VpcId"}, "Tags":{"shape":"TagList"}, - "HomeEfsFileSystemKmsKeyId":{"shape":"KmsKeyId"}, - "AppNetworkAccessType":{"shape":"AppNetworkAccessType"} + "AppNetworkAccessType":{"shape":"AppNetworkAccessType"}, + "HomeEfsFileSystemKmsKeyId":{"shape":"KmsKeyId"} } }, "CreateDomainResponse":{ @@ -2830,6 +3058,48 @@ "HyperParameterTuningJobArn":{"shape":"HyperParameterTuningJobArn"} } }, + "CreateImageRequest":{ + "type":"structure", + "required":[ + "ImageName", + "RoleArn" + ], + "members":{ + "Description":{"shape":"ImageDescription"}, + "DisplayName":{"shape":"ImageDisplayName"}, + "ImageName":{"shape":"ImageName"}, + "RoleArn":{"shape":"RoleArn"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateImageResponse":{ + "type":"structure", + "members":{ + "ImageArn":{"shape":"ImageArn"} + } + }, + "CreateImageVersionRequest":{ + "type":"structure", + "required":[ + "BaseImage", + "ClientToken", + "ImageName" + ], + "members":{ + "BaseImage":{"shape":"ImageBaseImage"}, + "ClientToken":{ + "shape":"ClientToken", + "idempotencyToken":true + }, + "ImageName":{"shape":"ImageName"} + } + }, + "CreateImageVersionResponse":{ + "type":"structure", + "members":{ + "ImageVersionArn":{"shape":"ImageVersionArn"} + } + }, "CreateLabelingJobRequest":{ "type":"structure", "required":[ @@ -2885,7 +3155,6 @@ }, "CreateModelPackageInput":{ "type":"structure", - "required":["ModelPackageName"], "members":{ "ModelPackageName":{"shape":"EntityName"}, "ModelPackageDescription":{"shape":"EntityDescription"}, @@ -3211,6 +3480,26 @@ "max":10, "min":1 }, + "CustomImage":{ + "type":"structure", + "required":[ + "ImageName", + "AppImageConfigName" + ], + "members":{ + "ImageName":{"shape":"ImageName"}, + "ImageVersionNumber":{ + "shape":"ImageVersionNumber", + "box":true + }, + "AppImageConfigName":{"shape":"AppImageConfigName"} + } + }, + "CustomImages":{ + "type":"list", + "member":{"shape":"CustomImage"}, + "max":30 + }, "DataCaptureConfig":{ "type":"structure", "required":[ @@ -3317,6 +3606,16 @@ "max":20, "min":0 }, + "DefaultGid":{ + "type":"integer", + "max":65535, + "min":0 + }, + "DefaultUid":{ + "type":"integer", + "max":65535, + "min":0 + }, "DeleteAlgorithmInput":{ "type":"structure", "required":["AlgorithmName"], @@ -3324,6 +3623,13 @@ "AlgorithmName":{"shape":"EntityName"} } }, + "DeleteAppImageConfigRequest":{ + "type":"structure", + "required":["AppImageConfigName"], + "members":{ + "AppImageConfigName":{"shape":"AppImageConfigName"} + } + }, "DeleteAppRequest":{ "type":"structure", "required":[ @@ -3405,6 +3711,34 @@ "members":{ } }, + "DeleteImageRequest":{ + "type":"structure", + "required":["ImageName"], + "members":{ + "ImageName":{"shape":"ImageName"} + } + }, + "DeleteImageResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteImageVersionRequest":{ + "type":"structure", + "required":[ + "ImageName", + "Version" + ], + "members":{ + "ImageName":{"shape":"ImageName"}, + "Version":{"shape":"ImageVersionNumber"} + } + }, + "DeleteImageVersionResponse":{ + "type":"structure", + "members":{ + } + }, "DeleteModelInput":{ "type":"structure", "required":["ModelName"], @@ -3416,7 +3750,7 @@ "type":"structure", "required":["ModelPackageName"], "members":{ - "ModelPackageName":{"shape":"EntityName"} + "ModelPackageName":{"shape":"VersionedArnOrName"} } }, "DeleteMonitoringScheduleRequest":{ @@ -3562,6 +3896,23 @@ "CertifyForMarketplace":{"shape":"CertifyForMarketplace"} } }, + "DescribeAppImageConfigRequest":{ + "type":"structure", + "required":["AppImageConfigName"], + "members":{ + "AppImageConfigName":{"shape":"AppImageConfigName"} + } + }, + "DescribeAppImageConfigResponse":{ + "type":"structure", + "members":{ + "AppImageConfigArn":{"shape":"AppImageConfigArn"}, + "AppImageConfigName":{"shape":"AppImageConfigName"}, + "CreationTime":{"shape":"Timestamp"}, + "LastModifiedTime":{"shape":"Timestamp"}, + "KernelGatewayImageConfig":{"shape":"KernelGatewayImageConfig"} + } + }, "DescribeAppRequest":{ "type":"structure", "required":[ @@ -3716,11 +4067,11 @@ "FailureReason":{"shape":"FailureReason"}, "AuthMode":{"shape":"AuthMode"}, "DefaultUserSettings":{"shape":"UserSettings"}, + "AppNetworkAccessType":{"shape":"AppNetworkAccessType"}, "HomeEfsFileSystemKmsKeyId":{"shape":"KmsKeyId"}, "SubnetIds":{"shape":"Subnets"}, "Url":{"shape":"String1024"}, - "VpcId":{"shape":"VpcId"}, - "AppNetworkAccessType":{"shape":"AppNetworkAccessType"} + "VpcId":{"shape":"VpcId"} } }, "DescribeEndpointConfigInput":{ @@ -3887,6 +4238,49 @@ "FailureReason":{"shape":"FailureReason"} } }, + "DescribeImageRequest":{ + "type":"structure", + "required":["ImageName"], + "members":{ + "ImageName":{"shape":"ImageName"} + } + }, + "DescribeImageResponse":{ + "type":"structure", + "members":{ + "CreationTime":{"shape":"Timestamp"}, + "Description":{"shape":"ImageDescription"}, + "DisplayName":{"shape":"ImageDisplayName"}, + "FailureReason":{"shape":"FailureReason"}, + "ImageArn":{"shape":"ImageArn"}, + "ImageName":{"shape":"ImageName"}, + "ImageStatus":{"shape":"ImageStatus"}, + "LastModifiedTime":{"shape":"Timestamp"}, + "RoleArn":{"shape":"RoleArn"} + } + }, + "DescribeImageVersionRequest":{ + "type":"structure", + "required":["ImageName"], + "members":{ + "ImageName":{"shape":"ImageName"}, + "Version":{"shape":"ImageVersionNumber"} + } + }, + "DescribeImageVersionResponse":{ + "type":"structure", + "members":{ + "BaseImage":{"shape":"ImageBaseImage"}, + "ContainerImage":{"shape":"ImageContainerImage"}, + "CreationTime":{"shape":"Timestamp"}, + "FailureReason":{"shape":"FailureReason"}, + "ImageArn":{"shape":"ImageArn"}, + "ImageVersionArn":{"shape":"ImageVersionArn"}, + "ImageVersionStatus":{"shape":"ImageVersionStatus"}, + "LastModifiedTime":{"shape":"Timestamp"}, + "Version":{"shape":"ImageVersionNumber"} + } + }, "DescribeLabelingJobRequest":{ "type":"structure", "required":["LabelingJobName"], @@ -3960,7 +4354,7 @@ "type":"structure", "required":["ModelPackageName"], "members":{ - "ModelPackageName":{"shape":"ArnOrName"} + "ModelPackageName":{"shape":"VersionedArnOrName"} } }, "DescribeModelPackageOutput":{ @@ -4432,7 +4826,10 @@ "Deleting", "Failed", "InService", - "Pending" + "Pending", + "Updating", + "Update_Failed", + "Delete_Failed" ] }, "DoubleParameterValue":{"type":"double"}, @@ -4632,7 +5029,7 @@ }, "ExperimentEntityName":{ "type":"string", - "max":82, + "max":120, "min":1, "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*" }, @@ -4675,6 +5072,20 @@ "ro" ] }, + "FileSystemConfig":{ + "type":"structure", + "members":{ + "MountPath":{"shape":"MountPath"}, + "DefaultUid":{ + "shape":"DefaultUid", + "box":true + }, + "DefaultGid":{ + "shape":"DefaultGid", + "box":true + } + } + }, "FileSystemDataSource":{ "type":"structure", "required":[ @@ -4850,7 +5261,8 @@ "ONNX", "PYTORCH", "XGBOOST", - "TFLITE" + "TFLITE", + "DARKNET" ] }, "GenerateCandidateDefinitionsOnly":{"type":"boolean"}, @@ -5027,6 +5439,11 @@ "MetricDefinitions":{"shape":"MetricDefinitionList"} } }, + "HyperParameterKey":{ + "type":"string", + "max":256, + "pattern":".*" + }, "HyperParameterScalingType":{ "type":"string", "enum":[ @@ -5049,7 +5466,7 @@ "Range":{"shape":"ParameterRange"}, "IsTunable":{"shape":"Boolean"}, "IsRequired":{"shape":"Boolean"}, - "DefaultValue":{"shape":"ParameterValue"} + "DefaultValue":{"shape":"HyperParameterValue"} } }, "HyperParameterSpecifications":{ @@ -5244,18 +5661,49 @@ "TransferLearning" ] }, + "HyperParameterValue":{ + "type":"string", + "max":2500, + "pattern":".*" + }, "HyperParameters":{ "type":"map", - "key":{"shape":"ParameterKey"}, - "value":{"shape":"ParameterValue"}, + "key":{"shape":"HyperParameterKey"}, + "value":{"shape":"HyperParameterValue"}, "max":100, "min":0 }, + "Image":{ + "type":"structure", + "required":[ + "CreationTime", + "ImageArn", + "ImageName", + "ImageStatus", + "LastModifiedTime" + ], + "members":{ + "CreationTime":{"shape":"Timestamp"}, + "Description":{"shape":"ImageDescription"}, + "DisplayName":{"shape":"ImageDisplayName"}, + "FailureReason":{"shape":"FailureReason"}, + "ImageArn":{"shape":"ImageArn"}, + "ImageName":{"shape":"ImageName"}, + "ImageStatus":{"shape":"ImageStatus"}, + "LastModifiedTime":{"shape":"Timestamp"} + } + }, "ImageArn":{ "type":"string", "max":256, "pattern":"^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$" }, + "ImageBaseImage":{ + "type":"string", + "max":255, + "min":1, + "pattern":".*" + }, "ImageConfig":{ "type":"structure", "required":["RepositoryAccessMode"], @@ -5263,16 +5711,144 @@ "RepositoryAccessMode":{"shape":"RepositoryAccessMode"} } }, + "ImageContainerImage":{ + "type":"string", + "max":255, + "min":1 + }, + "ImageDeleteProperty":{ + "type":"string", + "max":11, + "min":1, + "pattern":"(^DisplayName$)|(^Description$)" + }, + "ImageDeletePropertyList":{ + "type":"list", + "member":{"shape":"ImageDeleteProperty"}, + "max":2 + }, + "ImageDescription":{ + "type":"string", + "max":512, + "min":1, + "pattern":"^\\S(.*\\S)?$" + }, "ImageDigest":{ "type":"string", "max":72, "pattern":"^[Ss][Hh][Aa]256:[0-9a-fA-F]{64}$" }, + "ImageDisplayName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^\\S(.*\\S)?$" + }, + "ImageName":{ + "type":"string", + "max":63, + "min":1, + "pattern":"^[a-zA-Z0-9]([-.]?[a-zA-Z0-9])*$" + }, + "ImageNameContains":{ + "type":"string", + "max":63, + "pattern":"^[a-zA-Z0-9\\-.]+$" + }, + "ImageSortBy":{ + "type":"string", + "enum":[ + "CREATION_TIME", + "LAST_MODIFIED_TIME", + "IMAGE_NAME" + ] + }, + "ImageSortOrder":{ + "type":"string", + "enum":[ + "ASCENDING", + "DESCENDING" + ] + }, + "ImageStatus":{ + "type":"string", + "enum":[ + "CREATING", + "CREATED", + "CREATE_FAILED", + "UPDATING", + "UPDATE_FAILED", + "DELETING", + "DELETE_FAILED" + ] + }, "ImageUri":{ "type":"string", "max":255, "pattern":".*" }, + "ImageVersion":{ + "type":"structure", + "required":[ + "CreationTime", + "ImageArn", + "ImageVersionArn", + "ImageVersionStatus", + "LastModifiedTime", + "Version" + ], + "members":{ + "CreationTime":{"shape":"Timestamp"}, + "FailureReason":{"shape":"FailureReason"}, + "ImageArn":{"shape":"ImageArn"}, + "ImageVersionArn":{"shape":"ImageVersionArn"}, + "ImageVersionStatus":{"shape":"ImageVersionStatus"}, + "LastModifiedTime":{"shape":"Timestamp"}, + "Version":{"shape":"ImageVersionNumber"} + } + }, + "ImageVersionArn":{ + "type":"string", + "max":256, + "pattern":"^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+$" + }, + "ImageVersionNumber":{ + "type":"integer", + "min":0 + }, + "ImageVersionSortBy":{ + "type":"string", + "enum":[ + "CREATION_TIME", + "LAST_MODIFIED_TIME", + "VERSION" + ] + }, + "ImageVersionSortOrder":{ + "type":"string", + "enum":[ + "ASCENDING", + "DESCENDING" + ] + }, + "ImageVersionStatus":{ + "type":"string", + "enum":[ + "CREATING", + "CREATED", + "CREATE_FAILED", + "DELETING", + "DELETE_FAILED" + ] + }, + "ImageVersions":{ + "type":"list", + "member":{"shape":"ImageVersion"} + }, + "Images":{ + "type":"list", + "member":{"shape":"Image"} + }, "InferenceSpecification":{ "type":"structure", "required":[ @@ -5439,12 +6015,43 @@ "DefaultResourceSpec":{"shape":"ResourceSpec"} } }, + "KernelDisplayName":{ + "type":"string", + "max":1024 + }, "KernelGatewayAppSettings":{ "type":"structure", "members":{ - "DefaultResourceSpec":{"shape":"ResourceSpec"} + "DefaultResourceSpec":{"shape":"ResourceSpec"}, + "CustomImages":{"shape":"CustomImages"} + } + }, + "KernelGatewayImageConfig":{ + "type":"structure", + "required":["KernelSpecs"], + "members":{ + "KernelSpecs":{"shape":"KernelSpecs"}, + "FileSystemConfig":{"shape":"FileSystemConfig"} + } + }, + "KernelName":{ + "type":"string", + "max":1024 + }, + "KernelSpec":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{"shape":"KernelName"}, + "DisplayName":{"shape":"KernelDisplayName"} } }, + "KernelSpecs":{ + "type":"list", + "member":{"shape":"KernelSpec"}, + "max":1, + "min":1 + }, "KmsKeyId":{ "type":"string", "max":2048, @@ -5656,6 +6263,27 @@ "NextToken":{"shape":"NextToken"} } }, + "ListAppImageConfigsRequest":{ + "type":"structure", + "members":{ + "MaxResults":{"shape":"MaxResults"}, + "NextToken":{"shape":"NextToken"}, + "NameContains":{"shape":"AppImageConfigName"}, + "CreationTimeBefore":{"shape":"Timestamp"}, + "CreationTimeAfter":{"shape":"Timestamp"}, + "ModifiedTimeBefore":{"shape":"Timestamp"}, + "ModifiedTimeAfter":{"shape":"Timestamp"}, + "SortBy":{"shape":"AppImageConfigSortKey"}, + "SortOrder":{"shape":"SortOrder"} + } + }, + "ListAppImageConfigsResponse":{ + "type":"structure", + "members":{ + "NextToken":{"shape":"NextToken"}, + "AppImageConfigs":{"shape":"AppImageConfigList"} + } + }, "ListAppsRequest":{ "type":"structure", "members":{ @@ -5923,6 +6551,49 @@ "NextToken":{"shape":"NextToken"} } }, + "ListImageVersionsRequest":{ + "type":"structure", + "required":["ImageName"], + "members":{ + "CreationTimeAfter":{"shape":"Timestamp"}, + "CreationTimeBefore":{"shape":"Timestamp"}, + "ImageName":{"shape":"ImageName"}, + "LastModifiedTimeAfter":{"shape":"Timestamp"}, + "LastModifiedTimeBefore":{"shape":"Timestamp"}, + "MaxResults":{"shape":"MaxResults"}, + "NextToken":{"shape":"NextToken"}, + "SortBy":{"shape":"ImageVersionSortBy"}, + "SortOrder":{"shape":"ImageVersionSortOrder"} + } + }, + "ListImageVersionsResponse":{ + "type":"structure", + "members":{ + "ImageVersions":{"shape":"ImageVersions"}, + "NextToken":{"shape":"NextToken"} + } + }, + "ListImagesRequest":{ + "type":"structure", + "members":{ + "CreationTimeAfter":{"shape":"Timestamp"}, + "CreationTimeBefore":{"shape":"Timestamp"}, + "LastModifiedTimeAfter":{"shape":"Timestamp"}, + "LastModifiedTimeBefore":{"shape":"Timestamp"}, + "MaxResults":{"shape":"MaxResults"}, + "NameContains":{"shape":"ImageNameContains"}, + "NextToken":{"shape":"NextToken"}, + "SortBy":{"shape":"ImageSortBy"}, + "SortOrder":{"shape":"ImageSortOrder"} + } + }, + "ListImagesResponse":{ + "type":"structure", + "members":{ + "Images":{"shape":"Images"}, + "NextToken":{"shape":"NextToken"} + } + }, "ListLabelingJobsForWorkteamRequest":{ "type":"structure", "required":["WorkteamArn"], @@ -6421,7 +7092,7 @@ "MediaType":{ "type":"string", "max":64, - "pattern":"^[\\w]+\\/[\\w+]+$" + "pattern":"^[-\\w]+\\/[-\\w+]+$" }, "MemberDefinition":{ "type":"structure", @@ -6868,6 +7539,11 @@ "MaxRuntimeInSeconds":{"shape":"MonitoringMaxRuntimeInSeconds"} } }, + "MountPath":{ + "type":"string", + "max":1024, + "pattern":"^\\/.*" + }, "NameContains":{ "type":"string", "max":63, @@ -7852,6 +8528,7 @@ "type":"structure", "members":{ "SageMakerImageArn":{"shape":"ImageArn"}, + "SageMakerImageVersionArn":{"shape":"ImageVersionArn"}, "InstanceType":{"shape":"AppInstanceType"} } }, @@ -8119,7 +8796,7 @@ "SnsTopicArn":{ "type":"string", "max":2048, - "pattern":"arn:aws[a-z\\-]*:sns:[a-z0-9\\-]*:[0-9]{12}:[a-zA-Z0-9_.-]*" + "pattern":"arn:aws[a-z\\-]*:sns:[a-z0-9\\-]*:[0-9]{12}:[a-zA-Z0-9_.-]+" }, "SortBy":{ "type":"string", @@ -8572,6 +9249,7 @@ "ml.p3.8xlarge", "ml.p3.16xlarge", "ml.p3dn.24xlarge", + "ml.p4d.24xlarge", "ml.c5.xlarge", "ml.c5.2xlarge", "ml.c5.4xlarge", @@ -9183,6 +9861,20 @@ "ContentSha256":{"shape":"TemplateContentSha256"} } }, + "UpdateAppImageConfigRequest":{ + "type":"structure", + "required":["AppImageConfigName"], + "members":{ + "AppImageConfigName":{"shape":"AppImageConfigName"}, + "KernelGatewayImageConfig":{"shape":"KernelGatewayImageConfig"} + } + }, + "UpdateAppImageConfigResponse":{ + "type":"structure", + "members":{ + "AppImageConfigArn":{"shape":"AppImageConfigArn"} + } + }, "UpdateCodeRepositoryInput":{ "type":"structure", "required":["CodeRepositoryName"], @@ -9265,6 +9957,23 @@ "ExperimentArn":{"shape":"ExperimentArn"} } }, + "UpdateImageRequest":{ + "type":"structure", + "required":["ImageName"], + "members":{ + "DeleteProperties":{"shape":"ImageDeletePropertyList"}, + "Description":{"shape":"ImageDescription"}, + "DisplayName":{"shape":"ImageDisplayName"}, + "ImageName":{"shape":"ImageName"}, + "RoleArn":{"shape":"RoleArn"} + } + }, + "UpdateImageResponse":{ + "type":"structure", + "members":{ + "ImageArn":{"shape":"ImageArn"} + } + }, "UpdateMonitoringScheduleRequest":{ "type":"structure", "required":[ @@ -9459,7 +10168,10 @@ "Deleting", "Failed", "InService", - "Pending" + "Pending", + "Updating", + "Update_Failed", + "Delete_Failed" ] }, "UserSettings":{ @@ -9503,6 +10215,12 @@ "type":"float", "min":0 }, + "VersionedArnOrName":{ + "type":"string", + "max":176, + "min":1, + "pattern":"(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:[a-z\\-]*\\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(?Associates a trial component with a trial. A trial component can be associated with multiple trials. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.", "CreateAlgorithm": "Create a machine learning algorithm that you can use in Amazon SageMaker and list in the AWS Marketplace.
", "CreateApp": "Creates a running App for the specified UserProfile. Supported Apps are JupyterServer and KernelGateway. This operation is automatically invoked by Amazon SageMaker Studio upon access to the associated Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously.
", + "CreateAppImageConfig": "Creates a configuration for running an Amazon SageMaker image as a KernelGateway app.
", "CreateAutoMLJob": "Creates an Autopilot job.
Find the best performing model after you run an Autopilot job by calling . Deploy that model by following the steps described in Step 6.1: Deploy the Model to Amazon SageMaker Hosting Services.
For information about how to use Autopilot, see Automate Model Development with Amazon SageMaker Autopilot.
", "CreateCodeRepository": "Creates a Git repository as a resource in your Amazon SageMaker account. You can associate the repository with notebook instances so that you can use Git source control for the notebooks you create. The Git repository is a resource in your Amazon SageMaker account, so it can be associated with more than one notebook instance, and it persists independently from the lifecycle of any notebook instances it is associated with.
The repository can be hosted either in AWS CodeCommit or in any other Git repository.
", "CreateCompilationJob": "Starts a model compilation job. After the model has been compiled, Amazon SageMaker saves the resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify.
If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts with AWS IoT Greengrass. In that case, deploy them as an ML resource.
In the request body, you provide the following:
A name for the compilation job
Information about the input model artifacts
The output location for the compiled model and the device (target) that the model runs on
The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to perform the model compilation job.
You can also provide a Tag to track the model compilation job's resource use and costs. The response body contains the CompilationJobArn for the compiled job.
To stop a model compilation job, use StopCompilationJob. To get information about a particular model compilation job, use DescribeCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.
", - "CreateDomain": "Creates a Domain used by Amazon SageMaker Studio. A domain consists of an associated Amazon Elastic File System (EFS) volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) configurations. An AWS account is limited to one domain per region. Users within a domain can share notebook files and other artifacts with each other.
When a domain is created, an EFS volume is created for use by all of the users within the domain. Each user receives a private home directory within the EFS volume for notebooks, Git repositories, and data files.
VPC configuration
All SageMaker Studio traffic between the domain and the EFS volume is through the specified VPC and subnets. For other Studio traffic, you can specify the AppNetworkAccessType parameter. AppNetworkAccessType corresponds to the network access type that you choose when you onboard to Studio. The following options are available:
PublicInternetOnly - Non-EFS traffic goes through a VPC managed by Amazon SageMaker, which allows internet access. This is the default value.
VpcOnly - All Studio traffic is through the specified VPC and subnets. Internet access is disabled by default. To allow internet access, you must specify a NAT gateway.
When internet access is disabled, you won't be able to train or host models unless your VPC has an interface endpoint (PrivateLink) or a NAT gateway and your security groups allow outbound connections.
VpcOnly network access type
When you choose VpcOnly, you must specify the following:
Security group inbound and outbound rules to allow NFS traffic over TCP on port 2049 between the domain and the EFS volume
Security group inbound and outbound rules to allow traffic between the JupyterServer app and the KernelGateway apps
Interface endpoints to access the SageMaker API and SageMaker runtime
For more information, see:
Creates a Domain used by Amazon SageMaker Studio. A domain consists of an associated Amazon Elastic File System (EFS) volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) configurations. An AWS account is limited to one domain per region. Users within a domain can share notebook files and other artifacts with each other.
When a domain is created, an EFS volume is created for use by all of the users within the domain. Each user receives a private home directory within the EFS volume for notebooks, Git repositories, and data files.
VPC configuration
All SageMaker Studio traffic between the domain and the EFS volume is through the specified VPC and subnets. For other Studio traffic, you can specify the AppNetworkAccessType parameter. AppNetworkAccessType corresponds to the network access type that you choose when you onboard to Studio. The following options are available:
PublicInternetOnly - Non-EFS traffic goes through a VPC managed by Amazon SageMaker, which allows internet access. This is the default value.
VpcOnly - All Studio traffic is through the specified VPC and subnets. Internet access is disabled by default. To allow internet access, you must specify a NAT gateway.
When internet access is disabled, you won't be able to run a Studio notebook or to train or host models unless your VPC has an interface endpoint to the SageMaker API and runtime or a NAT gateway and your security groups allow outbound connections.
For more information, see Connect SageMaker Studio Notebooks to Resources in a VPC.
", "CreateEndpoint": "Creates an endpoint using the endpoint configuration specified in the request. Amazon SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the CreateEndpointConfig API.
Use this API to deploy models using Amazon SageMaker hosting services.
For an example that calls this method when deploying a model to Amazon SageMaker hosting services, see Deploy the Model to Amazon SageMaker Hosting Services (AWS SDK for Python (Boto 3)).
You must not delete an EndpointConfig that is in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.
The endpoint name must be unique within an AWS Region in your AWS account.
When it receives the request, Amazon SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them.
When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.
When Amazon SageMaker receives the request, it sets the endpoint status to Creating. After it creates the endpoint, it sets the status to InService. Amazon SageMaker can then process incoming requests for inferences. To check the status of an endpoint, use the DescribeEndpoint API.
If any of the models hosted at this endpoint get model data from an Amazon S3 location, Amazon SageMaker uses AWS Security Token Service to download model artifacts from the S3 path you provided. AWS STS is activated in your IAM user account by default. If you previously deactivated AWS STS for a region, you need to reactivate AWS STS for that region. For more information, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.
", "CreateEndpointConfig": "Creates an endpoint configuration that Amazon SageMaker hosting services uses to deploy models. In the configuration, you identify one or more models, created using the CreateModel API, to deploy and the resources that you want Amazon SageMaker to provision. Then you call the CreateEndpoint API.
Use this API if you want to use Amazon SageMaker hosting services to deploy models into production.
In the request, you define a ProductionVariant, for each model that you want to deploy. Each ProductionVariant parameter also describes the resources that you want Amazon SageMaker to provision. This includes the number and type of ML compute instances to deploy.
If you are hosting multiple models, you also assign a VariantWeight to specify how much traffic you want to allocate to each model. For example, suppose that you want to host two models, A and B, and you assign traffic weight 2 for model A and 1 for model B. Amazon SageMaker distributes two-thirds of the traffic to Model A, and one-third to model B.
For an example that calls this method when deploying a model to Amazon SageMaker hosting services, see Deploy the Model to Amazon SageMaker Hosting Services (AWS SDK for Python (Boto 3)).
When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.
Creates an SageMaker experiment. An experiment is a collection of trials that are observed, compared and evaluated as a group. A trial is a set of steps, called trial components, that produce a machine learning model.
The goal of an experiment is to determine the components that produce the best model. Multiple trials are performed, each one isolating and measuring the impact of a change to one or more inputs, while keeping the remaining inputs constant.
When you use Amazon SageMaker Studio or the Amazon SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the AWS SDK for Python (Boto), you must use the logging APIs provided by the SDK.
You can add tags to experiments, trials, trial components and then use the Search API to search for the tags.
To add a description to an experiment, specify the optional Description parameter. To add a description later, or to change the description, call the UpdateExperiment API.
To get a list of all your experiments, call the ListExperiments API. To view an experiment's properties, call the DescribeExperiment API. To get a list of all the trials associated with an experiment, call the ListTrials API. To create a trial call the CreateTrial API.
", "CreateFlowDefinition": "Creates a flow definition.
", "CreateHumanTaskUi": "Defines the settings you will use for the human review workflow user interface. Reviewers will see a three-panel interface with an instruction area, the item to review, and an input area.
", "CreateHyperParameterTuningJob": "Starts a hyperparameter tuning job. A hyperparameter tuning job finds the best version of a model by running many training jobs on your dataset using the algorithm you choose and values for hyperparameters within ranges that you specify. It then chooses the hyperparameter values that result in a model that performs the best, as measured by an objective metric that you choose.
", + "CreateImage": "Creates a SageMaker Image. A SageMaker image represents a set of container images. Each of these container images is represented by a SageMaker ImageVersion.
Creates a version of the SageMaker image specified by ImageName. The version represents the Amazon Container Registry (ECR) container image specified by BaseImage.
Creates a job that uses workers to label the data objects in your input dataset. You can use the labeled data to train machine learning models.
You can select your workforce from one of three providers:
A private workforce that you create. It can include employees, contractors, and outside experts. Use a private workforce when want the data to stay within your organization or when a specific set of skills is required.
One or more vendors that you select from the AWS Marketplace. Vendors provide expertise in specific areas.
The Amazon Mechanical Turk workforce. This is the largest workforce, but it should only be used for public data or data that has been stripped of any personally identifiable information.
You can also use automated data labeling to reduce the number of data objects that need to be labeled by a human. Automated data labeling uses active learning to determine if a data object can be labeled by machine or if it needs to be sent to a human worker. For more information, see Using Automated Data Labeling.
The data objects to be labeled are contained in an Amazon S3 bucket. You create a manifest file that describes the location of each object. For more information, see Using Input and Output Data.
The output can be used as the manifest file for another labeling job or as training data for your machine learning models.
", "CreateModel": "Creates a model in Amazon SageMaker. In the request, you name the model and describe a primary container. For the primary container, you specify the Docker image that contains inference code, artifacts (from prior training), and a custom environment map that the inference code uses when you deploy the model for predictions.
Use this API to create a model if you want to use Amazon SageMaker hosting services or run a batch transform job.
To host your model, you create an endpoint configuration with the CreateEndpointConfig API, and then create an endpoint with the CreateEndpoint API. Amazon SageMaker then deploys all of the containers that you defined for the model in the hosting environment.
For an example that calls this method when deploying a model to Amazon SageMaker hosting services, see Deploy the Model to Amazon SageMaker Hosting Services (AWS SDK for Python (Boto 3)).
To run a batch transform using your model, you start a job with the CreateTransformJob API. Amazon SageMaker uses your model and your dataset to get inferences which are then saved to a specified S3 location.
In the CreateModel request, you must define a container with the PrimaryContainer parameter.
In the request, you also provide an IAM role that Amazon SageMaker can assume to access model artifacts and docker image for deployment on ML compute hosting instances or for batch transform jobs. In addition, you also use the IAM role to manage permissions the inference code needs. For example, if the inference code access any other AWS resources, you grant necessary permissions via this role.
", "CreateModelPackage": "Creates a model package that you can use to create Amazon SageMaker models or list on AWS Marketplace. Buyers can subscribe to model packages listed on AWS Marketplace to create models in Amazon SageMaker.
To create a model package by specifying a Docker container that contains your inference code and the Amazon S3 location of your model artifacts, provide values for InferenceSpecification. To create a model from an algorithm resource that you created or subscribed to in AWS Marketplace, provide a value for SourceAlgorithmSpecification.
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.
", "DeleteAlgorithm": "Removes the specified algorithm from your account.
", "DeleteApp": "Used to stop and delete an app.
", + "DeleteAppImageConfig": "Deletes an AppImageConfig.
", "DeleteCodeRepository": "Deletes the specified Git repository from your account.
", "DeleteDomain": "Used to delete a domain. If you onboarded with IAM mode, you will need to delete your domain to onboard again using SSO. Use with caution. All of the members of the domain will lose access to their EFS volume, including data, notebooks, and other artifacts.
", "DeleteEndpoint": "Deletes an endpoint. Amazon SageMaker frees up all of the resources that were deployed when the endpoint was created.
Amazon SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't need to use the RevokeGrant API call.
", @@ -41,6 +45,8 @@ "DeleteExperiment": "Deletes an Amazon SageMaker experiment. All trials associated with the experiment must be deleted first. Use the ListTrials API to get a list of the trials associated with the experiment.
", "DeleteFlowDefinition": "Deletes the specified flow definition.
", "DeleteHumanTaskUi": "Use this operation to delete a human task user interface (worker task template).
To see a list of human task user interfaces (work task templates) in your account, use . When you delete a worker task template, it no longer appears when you call ListHumanTaskUis.
Deletes a SageMaker image and all versions of the image. The container images aren't deleted.
", + "DeleteImageVersion": "Deletes a version of a SageMaker image. The container image the version represents isn't deleted.
", "DeleteModel": "Deletes a model. The DeleteModel API deletes only the model entry that was created in Amazon SageMaker when you called the CreateModel API. It does not delete model artifacts, inference code, or the IAM role that you specified when creating the model.
Deletes a model package.
A model package is used to create Amazon SageMaker models or list on AWS Marketplace. Buyers can subscribe to model packages listed on AWS Marketplace to create models in Amazon SageMaker.
", "DeleteMonitoringSchedule": "Deletes a monitoring schedule. Also stops the schedule had not already been stopped. This does not delete the job execution history of the monitoring schedule.
", @@ -54,6 +60,7 @@ "DeleteWorkteam": "Deletes an existing work team. This operation can't be undone.
", "DescribeAlgorithm": "Returns a description of the specified algorithm that is in your account.
", "DescribeApp": "Describes the app.
", + "DescribeAppImageConfig": "Describes an AppImageConfig.
", "DescribeAutoMLJob": "Returns information about an Amazon SageMaker job.
", "DescribeCodeRepository": "Gets details about the specified Git repository.
", "DescribeCompilationJob": "Returns information about a model compilation job.
To create a model compilation job, use CreateCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.
", @@ -64,6 +71,8 @@ "DescribeFlowDefinition": "Returns information about the specified flow definition.
", "DescribeHumanTaskUi": "Returns information about the requested human task user interface (worker task template).
", "DescribeHyperParameterTuningJob": "Gets a description of a hyperparameter tuning job.
", + "DescribeImage": "Describes a SageMaker image.
", + "DescribeImageVersion": "Describes a version of a SageMaker image.
", "DescribeLabelingJob": "Gets information about a labeling job.
", "DescribeModel": "Describes a model that you created using the CreateModel API.
Returns a description of the specified model package, which is used to create Amazon SageMaker models or list them on AWS Marketplace.
To create models in Amazon SageMaker, buyers can subscribe to model packages listed on AWS Marketplace.
", @@ -82,6 +91,7 @@ "DisassociateTrialComponent": "Disassociates a trial component from a trial. This doesn't effect other trials the component is associated with. Before you can delete a component, you must disassociate the component from all trials it is associated with. To associate a trial component with a trial, call the AssociateTrialComponent API.
To get a list of the trials a component is associated with, use the Search API. Specify ExperimentTrialComponent for the Resource parameter. The list appears in the response under Results.TrialComponent.Parents.
An auto-complete API for the search functionality in the Amazon SageMaker console. It returns suggestions of possible matches for the property name to use in Search queries. Provides suggestions for HyperParameters, Tags, and Metrics.
Lists the machine learning algorithms that have been created.
", + "ListAppImageConfigs": "Lists the AppImageConfigs in your account and their properties. The list can be filtered by creation time or modified time, and whether the AppImageConfig name contains a specified string.
", "ListApps": "Lists apps.
", "ListAutoMLJobs": "Request a list of jobs.
", "ListCandidatesForAutoMLJob": "List the Candidates created for the job.
", @@ -94,6 +104,8 @@ "ListFlowDefinitions": "Returns information about the flow definitions in your account.
", "ListHumanTaskUis": "Returns information about the human task user interfaces in your account.
", "ListHyperParameterTuningJobs": "Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.
", + "ListImageVersions": "Lists the versions of a specified image and their properties. The list can be filtered by creation time or modified time.
", + "ListImages": "Lists the images in your account and their properties. The list can be filtered by creation time or modified time, and whether the image name contains a specified string.
", "ListLabelingJobs": "Gets a list of labeling jobs.
", "ListLabelingJobsForWorkteam": "Gets a list of labeling jobs assigned to a specified work team.
", "ListModelPackages": "Lists the model packages that have been created.
", @@ -126,11 +138,13 @@ "StopProcessingJob": "Stops a processing job.
", "StopTrainingJob": "Stops a training job. To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms might use this 120-second window to save the model artifacts, so the results of the training is not lost.
When it receives a StopTrainingJob request, Amazon SageMaker changes the status of the job to Stopping. After Amazon SageMaker stops the job, it sets the status to Stopped.
Stops a transform job.
When Amazon SageMaker receives a StopTransformJob request, the status of the job changes to Stopping. After Amazon SageMaker stops the job, the status is set to Stopped. When you stop a transform job before it is completed, Amazon SageMaker doesn't store the job's output in Amazon S3.
Updates the properties of an AppImageConfig.
", "UpdateCodeRepository": "Updates the specified Git repository with the specified values.
", "UpdateDomain": "Updates the default settings for new user profiles in the domain.
", "UpdateEndpoint": "Deploys the new EndpointConfig specified in the request, switches to using newly created endpoint, and then deletes resources provisioned for the endpoint using the previous EndpointConfig (there is no availability loss).
When Amazon SageMaker receives the request, it sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API.
You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.
If you delete the EndpointConfig of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges.
Updates variant weight of one or more variants associated with an existing endpoint, or capacity of one variant associated with an existing endpoint. When it receives the request, Amazon SageMaker sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API.
Adds, updates, or removes the description of an experiment. Updates the display name of an experiment.
", + "UpdateImage": "Updates the properties of a SageMaker image. To change the image's tags, use the AddTags and DeleteTags APIs.
", "UpdateMonitoringSchedule": "Updates a previously created schedule.
", "UpdateNotebookInstance": "Updates a notebook instance. NotebookInstance updates include upgrading or downgrading the ML compute instance used for your notebook instance to accommodate changes in your workload requirements.
", "UpdateNotebookInstanceLifecycleConfig": "Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig API.
", @@ -268,20 +282,60 @@ "AppArn": { "base": null, "refs": { - "CreateAppResponse$AppArn": "The App's Amazon Resource Name (ARN).
", - "DescribeAppResponse$AppArn": "The app's Amazon Resource Name (ARN).
" + "CreateAppResponse$AppArn": "The Amazon Resource Name (ARN) of the app.
", + "DescribeAppResponse$AppArn": "The Amazon Resource Name (ARN) of the app.
" } }, "AppDetails": { - "base": "The app's details.
", + "base": "Details about an Amazon SageMaker app.
", "refs": { "AppList$member": null } }, + "AppImageConfigArn": { + "base": null, + "refs": { + "AppImageConfigDetails$AppImageConfigArn": "The Amazon Resource Name (ARN) of the AppImageConfig.
", + "CreateAppImageConfigResponse$AppImageConfigArn": "The Amazon Resource Name (ARN) of the AppImageConfig.
", + "DescribeAppImageConfigResponse$AppImageConfigArn": "The Amazon Resource Name (ARN) of the AppImageConfig.
", + "UpdateAppImageConfigResponse$AppImageConfigArn": "The Amazon Resource Name (ARN) for the AppImageConfig.
" + } + }, + "AppImageConfigDetails": { + "base": "The configuration for running an Amazon SageMaker image as a KernelGateway app.
", + "refs": { + "AppImageConfigList$member": null + } + }, + "AppImageConfigList": { + "base": null, + "refs": { + "ListAppImageConfigsResponse$AppImageConfigs": "A list of AppImageConfigs and their properties.
" + } + }, + "AppImageConfigName": { + "base": null, + "refs": { + "AppImageConfigDetails$AppImageConfigName": "The name of the AppImageConfig.
", + "CreateAppImageConfigRequest$AppImageConfigName": "The name of the AppImageConfig. Must be unique to your account.
", + "CustomImage$AppImageConfigName": "The name of the AppImageConfig.
", + "DeleteAppImageConfigRequest$AppImageConfigName": "The name of the AppImageConfig to delete.
", + "DescribeAppImageConfigRequest$AppImageConfigName": "The name of the AppImageConfig to describe.
", + "DescribeAppImageConfigResponse$AppImageConfigName": "The name of the AppImageConfig.
", + "ListAppImageConfigsRequest$NameContains": "A filter that returns only AppImageConfigs whose name contains the specified string.
", + "UpdateAppImageConfigRequest$AppImageConfigName": "The name of the AppImageConfig to update.
" + } + }, + "AppImageConfigSortKey": { + "base": null, + "refs": { + "ListAppImageConfigsRequest$SortBy": "The property used to sort results. The default value is CreationTime.
The instance type.
" + "ResourceSpec$InstanceType": "The instance type that the image version runs on.
" } }, "AppList": { @@ -342,9 +396,7 @@ "base": null, "refs": { "AlgorithmSpecification$AlgorithmName": "The name of the algorithm resource to use for the training job. This must be an algorithm resource that you created or subscribe to on AWS Marketplace. If you specify a value for this parameter, you can't specify a value for TrainingImage.
The name or Amazon Resource Name (ARN) of the model package to use to create the model.
", "DescribeAlgorithmInput$AlgorithmName": "The name of the algorithm to describe.
", - "DescribeModelPackageInput$ModelPackageName": "The name of the model package to describe.
", "HyperParameterAlgorithmSpecification$AlgorithmName": "The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for this parameter, do not specify a value for TrainingImage.
The name of an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your Amazon SageMaker account or an algorithm in AWS Marketplace that you are subscribed to.
" } @@ -822,6 +874,12 @@ "OidcConfig$ClientSecret": "The OIDC IdP client secret used to configure your private workforce.
" } }, + "ClientToken": { + "base": null, + "refs": { + "CreateImageVersionRequest$ClientToken": "A unique ID. If not specified, the AWS CLI and AWS SDKs, such as the SDK for Python (Boto3), add a unique value to the call.
" + } + }, "CodeRepositoryArn": { "base": null, "refs": { @@ -959,7 +1017,7 @@ "CompilerOptions": { "base": null, "refs": { - "OutputConfig$CompilerOptions": "Specifies additional parameters for compiler options in JSON format. The compiler options are TargetPlatform specific. It is required for NVIDIA accelerators and highly recommended for CPU compilations. For any other cases, it is optional to specify CompilerOptions.
CPU: Compilation for CPU supports the following compiler options.
mcpu: CPU micro-architecture. For example, {'mcpu': 'skylake-avx512'}
mattr: CPU flags. For example, {'mattr': ['+neon', '+vfpv4']}
ARM: Details of ARM CPU compilations.
NEON: NEON is an implementation of the Advanced SIMD extension used in ARMv7 processors.
For example, add {'mattr': ['+neon']} to the compiler options if compiling for ARM 32-bit platform with the NEON support.
NVIDIA: Compilation for NVIDIA GPU supports the following compiler options.
gpu_code: Specifies the targeted architecture.
trt-ver: Specifies the TensorRT versions in x.y.z. format.
cuda-ver: Specifies the CUDA version in x.y format.
For example, {'gpu-code': 'sm_72', 'trt-ver': '6.0.1', 'cuda-ver': '10.1'}
ANDROID: Compilation for the Android OS supports the following compiler options:
ANDROID_PLATFORM: Specifies the Android API levels. Available levels range from 21 to 29. For example, {'ANDROID_PLATFORM': 28}.
mattr: Add {'mattr': ['+neon']} to compiler options if compiling for ARM 32-bit platform with NEON support.
CoreML: Compilation for the CoreML OutputConfig$TargetDevice supports the following compiler options:
class_labels: Specifies the classification labels file name inside input tar.gz file. For example, {\"class_labels\": \"imagenet_labels_1000.txt\"}. Labels inside the txt file should be separated by newlines.
Specifies additional parameters for compiler options in JSON format. The compiler options are TargetPlatform specific. It is required for NVIDIA accelerators and highly recommended for CPU compilations. For any other cases, it is optional to specify CompilerOptions.
CPU: Compilation for CPU supports the following compiler options.
mcpu: CPU micro-architecture. For example, {'mcpu': 'skylake-avx512'}
mattr: CPU flags. For example, {'mattr': ['+neon', '+vfpv4']}
ARM: Details of ARM CPU compilations.
NEON: NEON is an implementation of the Advanced SIMD extension used in ARMv7 processors.
For example, add {'mattr': ['+neon']} to the compiler options if compiling for ARM 32-bit platform with the NEON support.
NVIDIA: Compilation for NVIDIA GPU supports the following compiler options.
gpu_code: Specifies the targeted architecture.
trt-ver: Specifies the TensorRT versions in x.y.z. format.
cuda-ver: Specifies the CUDA version in x.y format.
For example, {'gpu-code': 'sm_72', 'trt-ver': '6.0.1', 'cuda-ver': '10.1'}
ANDROID: Compilation for the Android OS supports the following compiler options:
ANDROID_PLATFORM: Specifies the Android API levels. Available levels range from 21 to 29. For example, {'ANDROID_PLATFORM': 28}.
mattr: Add {'mattr': ['+neon']} to compiler options if compiling for ARM 32-bit platform with NEON support.
INFERENTIA: Compilation for target ml_inf1 uses compiler options passed in as a JSON string. For example, \"CompilerOptions\": \"\\\"--verbose 1 --num-neuroncores 2 -O2\\\"\".
For information about supported compiler options, see Neuron Compiler CLI.
CoreML: Compilation for the CoreML OutputConfig$TargetDevice supports the following compiler options:
class_labels: Specifies the classification labels file name inside input tar.gz file. For example, {\"class_labels\": \"imagenet_labels_1000.txt\"}. Labels inside the txt file should be separated by newlines.
A custom image.
", + "refs": { + "CustomImages$member": null + } + }, + "CustomImages": { + "base": null, + "refs": { + "KernelGatewayAppSettings$CustomImages": "A list of custom images that are configured to run as a KernelGateway app.
" + } + }, "DataCaptureConfig": { "base": "", "refs": { @@ -1509,11 +1609,28 @@ "TrainingJob$DebugRuleEvaluationStatuses": "Information about the evaluation status of the rules for the training job.
" } }, + "DefaultGid": { + "base": null, + "refs": { + "FileSystemConfig$DefaultGid": "The default POSIX group ID. If not specified, defaults to 100.
The default POSIX user ID. If not specified, defaults to 1000.
The name of the endpoint. The name must be unique within an AWS Region in your AWS account.
", + "CreateEndpointInput$EndpointName": "The name of the endpoint.The name must be unique within an AWS Region in your AWS account. The name is case-insensitive in CreateEndpoint, but the case is preserved and must be matched in .
The name of the endpoint that you want to delete.
", "DescribeEndpointInput$EndpointName": "The name of the endpoint.
", "DescribeEndpointOutput$EndpointName": "Name of the endpoint.
", @@ -2236,7 +2403,6 @@ "CreateModelPackageInput$ModelPackageName": "The name of the model package. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).
", "DeleteAlgorithmInput$AlgorithmName": "The name of the algorithm to delete.
", "DeleteCodeRepositoryInput$CodeRepositoryName": "The name of the Git repository to delete.
", - "DeleteModelPackageInput$ModelPackageName": "The name of the model package. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).
", "DescribeAlgorithmOutput$AlgorithmName": "The name of the algorithm being described.
", "DescribeCodeRepositoryInput$CodeRepositoryName": "The name of the Git repository to describe.
", "DescribeCodeRepositoryOutput$CodeRepositoryName": "The name of the Git repository.
", @@ -2418,6 +2584,8 @@ "DescribeEndpointOutput$FailureReason": "If the status of the endpoint is Failed, the reason why it failed.
The reason your flow definition failed.
", "DescribeHyperParameterTuningJobResponse$FailureReason": "If the tuning job failed, the reason it failed.
", + "DescribeImageResponse$FailureReason": "When a create, update, or delete operation fails, the reason for the failure.
", + "DescribeImageVersionResponse$FailureReason": "When a create or delete operation fails, the reason for the failure.
", "DescribeLabelingJobResponse$FailureReason": "If the job failed, the reason that it failed.
", "DescribeMonitoringScheduleResponse$FailureReason": "A string, up to one KB in size, that contains the reason a monitoring job failed, if it failed.
", "DescribeNotebookInstanceOutput$FailureReason": "If status is Failed, the reason it failed.
The failure reason.
", "FlowDefinitionSummary$FailureReason": "The reason why the flow definition creation failed. A failure reason is returned only when the flow definition status is Failed.
The reason that the training job failed.
", + "Image$FailureReason": "When a create, update, or delete operation fails, the reason for the failure.
", + "ImageVersion$FailureReason": "When a create or delete operation fails, the reason for the failure.
", "LabelingJobSummary$FailureReason": "If the LabelingJobStatus field is Failed, this field contains a description of the error.
Contains the reason a monitoring job failed, if it failed.
", "ProcessingJob$FailureReason": "A string, up to one KB in size, that contains the reason a processing job failed, if it failed.
", @@ -2445,6 +2615,12 @@ "FileSystemDataSource$FileSystemAccessMode": "The access mode of the mount of the directory associated with the channel. A directory can be mounted either in ro (read-only) or rw (read-write) mode.
The Amazon Elastic File System (EFS) storage configuration for an image.
", + "refs": { + "KernelGatewayImageConfig$FileSystemConfig": "The file system configuration.
" + } + }, "FileSystemDataSource": { "base": "Specifies a file system data source for a channel.
", "refs": { @@ -2739,6 +2915,12 @@ "HyperParameterTrainingJobDefinition$AlgorithmSpecification": "The HyperParameterAlgorithmSpecification object that specifies the resource algorithm to use for the training jobs that the tuning job launches.
" } }, + "HyperParameterKey": { + "base": null, + "refs": { + "HyperParameters$key": null + } + }, "HyperParameterScalingType": { "base": null, "refs": { @@ -2814,7 +2996,7 @@ "HyperParameterTuningJobName": { "base": null, "refs": { - "CreateHyperParameterTuningJobRequest$HyperParameterTuningJobName": "The name of the tuning job. This name is the prefix for the names of all training jobs that this tuning job launches. The name must be unique within the same AWS account and AWS Region. The name must have { } to { } characters. Valid characters are a-z, A-Z, 0-9, and : + = @ _ % - (hyphen). The name is not case sensitive.
", + "CreateHyperParameterTuningJobRequest$HyperParameterTuningJobName": "The name of the tuning job. This name is the prefix for the names of all training jobs that this tuning job launches. The name must be unique within the same AWS account and AWS Region. The name must have 1 to 32 characters. Valid characters are a-z, A-Z, 0-9, and : + = @ _ % - (hyphen). The name is not case sensitive.
", "DescribeHyperParameterTuningJobRequest$HyperParameterTuningJobName": "The name of the tuning job.
", "DescribeHyperParameterTuningJobResponse$HyperParameterTuningJobName": "The name of the tuning job.
", "HyperParameterTrainingJobSummary$TuningJobName": "The HyperParameter tuning job that launched the training job.
", @@ -2891,6 +3073,13 @@ "HyperParameterTuningJobWarmStartConfig$WarmStartType": "Specifies one of the following:
The new hyperparameter tuning job uses the same input data and training image as the parent tuning jobs. You can change the hyperparameter ranges to search and the maximum number of training jobs that the hyperparameter tuning job launches. You cannot use a new version of the training algorithm, unless the changes in the new version do not affect the algorithm itself. For example, changes that improve logging or adding support for a different data format are allowed. You can also change hyperparameters from tunable to static, and from static to tunable, but the total number of static plus tunable hyperparameters must remain the same as it is in all parent jobs. The objective metric for the new tuning job must be the same as for all parent jobs.
The new hyperparameter tuning job can include input data, hyperparameter ranges, maximum number of concurrent training jobs, and maximum number of training jobs that are different than those of its parent hyperparameter tuning jobs. The training image can also be a different version from the version used in the parent hyperparameter tuning job. You can also change hyperparameters from tunable to static, and from static to tunable, but the total number of static plus tunable hyperparameters must remain the same as it is in all parent jobs. The objective metric for the new tuning job must be the same as for all parent jobs.
The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.
", + "HyperParameters$value": null + } + }, "HyperParameters": { "base": null, "refs": { @@ -2902,10 +3091,29 @@ "TrainingJobDefinition$HyperParameters": "The hyperparameters used for the training job.
" } }, + "Image": { + "base": "A SageMaker image. A SageMaker image represents a set of container images that are derived from a common base container image. Each of these container images is represented by a SageMaker ImageVersion.
The Amazon Resource Name (ARN) of the SageMaker image created on the instance.
" + "CreateImageResponse$ImageArn": "The Amazon Resource Name (ARN) of the image.
", + "DescribeImageResponse$ImageArn": "The Amazon Resource Name (ARN) of the image.
", + "DescribeImageVersionResponse$ImageArn": "The Amazon Resource Name (ARN) of the image the version is based on.
", + "Image$ImageArn": "The Amazon Resource Name (ARN) of the image.
", + "ImageVersion$ImageArn": "The Amazon Resource Name (ARN) of the image the version is based on.
", + "ResourceSpec$SageMakerImageArn": "The ARN of the SageMaker image that the image version belongs to.
", + "UpdateImageResponse$ImageArn": "The Amazon Resource Name (ARN) of the image.
" + } + }, + "ImageBaseImage": { + "base": null, + "refs": { + "CreateImageVersionRequest$BaseImage": "The registry path of the container image to use as the starting point for this version. The path is an Amazon Container Registry (ECR) URI in the following format:
<acct-id>.dkr.ecr.<region>.amazonaws.com/<repo-name[:tag] or [@digest]>
The registry path of the container image on which this image version is based.
" } }, "ImageConfig": { @@ -2914,6 +3122,33 @@ "ContainerDefinition$ImageConfig": "Specifies whether the model container is in Amazon ECR or a private Docker registry accessible from your Amazon Virtual Private Cloud (VPC). For information about storing containers in a private Docker registry, see Use a Private Docker Registry for Real-Time Inference Containers
" } }, + "ImageContainerImage": { + "base": null, + "refs": { + "DescribeImageVersionResponse$ContainerImage": "The registry path of the container image that contains this image version.
" + } + }, + "ImageDeleteProperty": { + "base": null, + "refs": { + "ImageDeletePropertyList$member": null + } + }, + "ImageDeletePropertyList": { + "base": null, + "refs": { + "UpdateImageRequest$DeleteProperties": "A list of properties to delete. Only the Description and DisplayName properties can be deleted.
The description of the image.
", + "DescribeImageResponse$Description": "The description of the image.
", + "Image$Description": "The description of the image.
", + "UpdateImageRequest$Description": "The new description for the image.
" + } + }, "ImageDigest": { "base": null, "refs": { @@ -2921,6 +3156,56 @@ "TrainingSpecification$TrainingImageDigest": "An MD5 hash of the training algorithm that identifies the Docker image used for training.
" } }, + "ImageDisplayName": { + "base": null, + "refs": { + "CreateImageRequest$DisplayName": "The display name of the image. When the image is added to a domain, DisplayName must be unique to the domain.
The name of the image as displayed.
", + "Image$DisplayName": "The name of the image as displayed.
", + "UpdateImageRequest$DisplayName": "The new display name for the image.
" + } + }, + "ImageName": { + "base": null, + "refs": { + "CreateImageRequest$ImageName": "The name of the image. Must be unique to your account.
", + "CreateImageVersionRequest$ImageName": "The ImageName of the Image to create a version of.
The name of the CustomImage. Must be unique to your account.
", + "DeleteImageRequest$ImageName": "The name of the image to delete.
", + "DeleteImageVersionRequest$ImageName": "The name of the image.
", + "DescribeImageRequest$ImageName": "The name of the image to describe.
", + "DescribeImageResponse$ImageName": "The name of the image.
", + "DescribeImageVersionRequest$ImageName": "The name of the image.
", + "Image$ImageName": "The name of the image.
", + "ListImageVersionsRequest$ImageName": "The name of the image to list the versions of.
", + "UpdateImageRequest$ImageName": "The name of the image to update.
" + } + }, + "ImageNameContains": { + "base": null, + "refs": { + "ListImagesRequest$NameContains": "A filter that returns only images whose name contains the specified string.
" + } + }, + "ImageSortBy": { + "base": null, + "refs": { + "ListImagesRequest$SortBy": "The property used to sort results. The default value is CREATION_TIME.
The sort order. The default value is DESCENDING.
The status of the image.
", + "Image$ImageStatus": "The status of the image.
" + } + }, "ImageUri": { "base": null, "refs": { @@ -2928,6 +3213,62 @@ "MonitoringAppSpecification$ImageUri": "The container image to be run by the monitoring job.
" } }, + "ImageVersion": { + "base": "A version of a SageMaker Image. A version represents an existing container image.
The Amazon Resource Name (ARN) of the image version.
", + "DescribeImageVersionResponse$ImageVersionArn": "The ARN of the version.
", + "ImageVersion$ImageVersionArn": "The ARN of the version.
", + "ResourceSpec$SageMakerImageVersionArn": "The ARN of the image version created on the instance.
" + } + }, + "ImageVersionNumber": { + "base": null, + "refs": { + "CustomImage$ImageVersionNumber": "The version number of the CustomImage.
", + "DeleteImageVersionRequest$Version": "The version to delete.
", + "DescribeImageVersionRequest$Version": "The version of the image. If not specified, the latest version is described.
", + "DescribeImageVersionResponse$Version": "The version number.
", + "ImageVersion$Version": "The version number.
" + } + }, + "ImageVersionSortBy": { + "base": null, + "refs": { + "ListImageVersionsRequest$SortBy": "The property used to sort results. The default value is CREATION_TIME.
The sort order. The default value is DESCENDING.
The status of the version.
", + "ImageVersion$ImageVersionStatus": "The status of the version.
" + } + }, + "ImageVersions": { + "base": null, + "refs": { + "ListImageVersionsResponse$ImageVersions": "A list of versions and their properties.
" + } + }, + "Images": { + "base": null, + "refs": { + "ListImagesResponse$Images": "A list of images and their properties.
" + } + }, "InferenceSpecification": { "base": "Defines how to perform inference generation after a training job is run.
", "refs": { @@ -3043,12 +3384,45 @@ "UserSettings$JupyterServerAppSettings": "The Jupyter server's app settings.
" } }, + "KernelDisplayName": { + "base": null, + "refs": { + "KernelSpec$DisplayName": "The display name of the kernel.
" + } + }, "KernelGatewayAppSettings": { - "base": "The kernel gateway app settings.
", + "base": "The KernelGateway app settings.
", "refs": { "UserSettings$KernelGatewayAppSettings": "The kernel gateway app settings.
" } }, + "KernelGatewayImageConfig": { + "base": "The configuration for an Amazon SageMaker KernelGateway app.
", + "refs": { + "AppImageConfigDetails$KernelGatewayImageConfig": "The KernelGateway app.
", + "CreateAppImageConfigRequest$KernelGatewayImageConfig": "The KernelGatewayImageConfig.
", + "DescribeAppImageConfigResponse$KernelGatewayImageConfig": "The KernelGateway app.
", + "UpdateAppImageConfigRequest$KernelGatewayImageConfig": "The new KernelGateway app to run on the image.
" + } + }, + "KernelName": { + "base": null, + "refs": { + "KernelSpec$Name": "The name of the kernel. Must be unique to your account.
" + } + }, + "KernelSpec": { + "base": "Defines how a kernel is started and the arguments, environment variables, and metadata that are available to the kernel.
", + "refs": { + "KernelSpecs$member": null + } + }, + "KernelSpecs": { + "base": null, + "refs": { + "KernelGatewayImageConfig$KernelSpecs": "Defines how a kernel is started and the arguments, environment variables, and metadata that are available to the kernel.
" + } + }, "KmsKeyId": { "base": null, "refs": { @@ -3278,6 +3652,16 @@ "refs": { } }, + "ListAppImageConfigsRequest": { + "base": null, + "refs": { + } + }, + "ListAppImageConfigsResponse": { + "base": null, + "refs": { + } + }, "ListAppsRequest": { "base": null, "refs": { @@ -3404,6 +3788,26 @@ "refs": { } }, + "ListImageVersionsRequest": { + "base": null, + "refs": { + } + }, + "ListImageVersionsResponse": { + "base": null, + "refs": { + } + }, + "ListImagesRequest": { + "base": null, + "refs": { + } + }, + "ListImagesResponse": { + "base": null, + "refs": { + } + }, "ListLabelingJobsForWorkteamRequest": { "base": null, "refs": { @@ -3690,6 +4094,7 @@ "base": null, "refs": { "ListAlgorithmsInput$MaxResults": "The maximum number of algorithms to return in the response.
", + "ListAppImageConfigsRequest$MaxResults": "The maximum number of AppImageConfigs to return in the response. The default value is 10.
", "ListAppsRequest$MaxResults": "Returns a list up to a specified limit.
", "ListCodeRepositoriesInput$MaxResults": "The maximum number of Git repositories to return in the response.
", "ListCompilationJobsRequest$MaxResults": "The maximum number of model compilation jobs to return in the response.
", @@ -3700,6 +4105,8 @@ "ListFlowDefinitionsRequest$MaxResults": "The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.
The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.
The maximum number of tuning jobs to return. The default value is 10.
", + "ListImageVersionsRequest$MaxResults": "The maximum number of versions to return in the response. The default value is 10.
", + "ListImagesRequest$MaxResults": "The maximum number of images to return in the response. The default value is 10.
", "ListLabelingJobsForWorkteamRequest$MaxResults": "The maximum number of labeling jobs to return in each page of the response.
", "ListLabelingJobsRequest$MaxResults": "The maximum number of labeling jobs to return in each page of the response.
", "ListModelPackagesInput$MaxResults": "The maximum number of model packages to return in the response.
", @@ -4128,6 +4535,12 @@ "MonitoringJobDefinition$StoppingCondition": "Specifies a time limit for how long the monitoring job is allowed to run.
" } }, + "MountPath": { + "base": null, + "refs": { + "FileSystemConfig$MountPath": "The path within the image to mount the user's EFS home directory. The directory should be empty. If not specified, defaults to /home/sagemaker-user.
" + } + }, "NameContains": { "base": null, "refs": { @@ -4173,6 +4586,8 @@ "refs": { "ListAlgorithmsInput$NextToken": "If the response to a previous ListAlgorithms request was truncated, the response includes a NextToken. To retrieve the next set of algorithms, use the token in the next request.
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.
", + "ListAppImageConfigsRequest$NextToken": "If the previous call to ListImages didn't return the full set of AppImageConfigs, the call returns a token for getting the next set of AppImageConfigs.
A token for getting the next set of AppImageConfigs, if there are any.
", "ListAppsRequest$NextToken": "If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
", "ListAppsResponse$NextToken": "If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
", "ListAutoMLJobsRequest$NextToken": "If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
", @@ -4193,6 +4608,10 @@ "ListHumanTaskUisResponse$NextToken": "A token to resume pagination.
", "ListHyperParameterTuningJobsRequest$NextToken": "If the result of the previous ListHyperParameterTuningJobs request was truncated, the response includes a NextToken. To retrieve the next set of tuning jobs, use the token in the next request.
If the result of this ListHyperParameterTuningJobs request was truncated, the response includes a NextToken. To retrieve the next set of tuning jobs, use the token in the next request.
If the previous call to ListImageVersions didn't return the full set of versions, the call returns a token for getting the next set of versions.
A token for getting the next set of versions, if there are any.
", + "ListImagesRequest$NextToken": "If the previous call to ListImages didn't return the full set of images, the call returns a token for getting the next set of images.
A token for getting the next set of images, if there are any.
", "ListLabelingJobsForWorkteamRequest$NextToken": "If the result of the previous ListLabelingJobsForWorkteam request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.
", "ListLabelingJobsRequest$NextToken": "If the result of the previous ListLabelingJobs request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.
The name of the categorical hyperparameter to tune.
", "ContinuousParameterRange$Name": "The name of the continuous hyperparameter to tune.
", - "HyperParameters$key": null, "IntegerParameterRange$Name": "The name of the hyperparameter to search.
" } }, @@ -4590,8 +5008,6 @@ "ContinuousParameterRange$MaxValue": "The maximum value for the hyperparameter. The tuning job uses floating-point values between MinValue value and this value for tuning.
The minimum floating-point value allowed.
", "ContinuousParameterRangeSpecification$MaxValue": "The maximum floating-point value allowed.
", - "HyperParameterSpecification$DefaultValue": "The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.
", - "HyperParameters$value": null, "IntegerParameterRange$MinValue": "The minimum value of the hyperparameter to search.
", "IntegerParameterRange$MaxValue": "The maximum value of the hyperparameter to search.
", "IntegerParameterRangeSpecification$MinValue": "The minimum integer value allowed.
", @@ -5043,12 +5459,12 @@ } }, "ResourceSpec": { - "base": "The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. The ARN is stored as metadata in SageMaker Studio notebooks.
", + "base": "Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that the version runs on.
", "refs": { "CreateAppRequest$ResourceSpec": "The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
", "DescribeAppResponse$ResourceSpec": "The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
", "JupyterServerAppSettings$DefaultResourceSpec": "The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
", - "KernelGatewayAppSettings$DefaultResourceSpec": "The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
", + "KernelGatewayAppSettings$DefaultResourceSpec": "The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.
", "TensorBoardAppSettings$DefaultResourceSpec": "The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
" } }, @@ -5090,6 +5506,7 @@ "CreateAutoMLJobRequest$RoleArn": "The ARN of the role that is used to access the data.
", "CreateCompilationJobRequest$RoleArn": "The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
During model compilation, Amazon SageMaker needs your permission to:
Read input data from an S3 bucket
Write model artifacts to an S3 bucket
Write logs to Amazon CloudWatch Logs
Publish metrics to Amazon CloudWatch
You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker Roles.
The Amazon Resource Name (ARN) of the role needed to call other services on your behalf. For example, arn:aws:iam::1234567890:role/service-role/AmazonSageMaker-ExecutionRole-20180111T151298.
The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
", "CreateLabelingJobRequest$RoleArn": "The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete data labeling.
", "CreateModelInput$ExecutionRoleArn": "The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker can assume to access model artifacts and docker image for deployment on ML compute instances or for batch transform jobs. Deploying on ML compute instances is part of model hosting. For more information, see Amazon SageMaker Roles.
To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission.
When you send any requests to AWS resources from the notebook instance, Amazon SageMaker assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so Amazon SageMaker can perform these tasks. The policy must allow the Amazon SageMaker service principal (sagemaker.amazonaws.com) permissions to assume this role. For more information, see Amazon SageMaker Roles.
To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission.
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that has read permission to the input data location and write permission to the output data location in Amazon S3.
", "DescribeCompilationJobResponse$RoleArn": "The Amazon Resource Name (ARN) of the model compilation job.
", "DescribeFlowDefinitionResponse$RoleArn": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) execution role for the flow definition.
", + "DescribeImageResponse$RoleArn": "The Amazon Resource Name (ARN) of the IAM role that enables Amazon SageMaker to perform tasks on your behalf.
", "DescribeLabelingJobResponse$RoleArn": "The Amazon Resource Name (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling.
", "DescribeModelOutput$ExecutionRoleArn": "The Amazon Resource Name (ARN) of the IAM role that you specified for the model.
", "DescribeNotebookInstanceOutput$RoleArn": "The Amazon Resource Name (ARN) of the IAM role associated with the instance.
", @@ -5109,6 +5527,7 @@ "ProcessingJob$RoleArn": "The ARN of the role used to create the processing job.
", "RenderUiTemplateRequest$RoleArn": "The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the template.
", "TrainingJob$RoleArn": "The AWS Identity and Access Management (IAM) role configured for the training job.
", + "UpdateImageRequest$RoleArn": "The new Amazon Resource Name (ARN) for the IAM role that enables Amazon SageMaker to perform tasks on your behalf.
", "UpdateNotebookInstanceInput$RoleArn": "The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker can assume to access the notebook instance. For more information, see Amazon SageMaker Roles.
To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission.
The execution role for the user.
" } @@ -5165,7 +5584,7 @@ "AutoMLOutputDataConfig$S3OutputPath": "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 Amazon SageMaker to store checkpoints. For example, s3://bucket-name/key-name-prefix.
The S3 URL of the file that defines the categories used to label the data objects.
For 3D point cloud task types, see Create a Labeling Category Configuration File for 3D Point Cloud Labeling Jobs.
For all other built-in task types and custom tasks, your label category configuration file must be a JSON file in the following format. Identify the labels you want to use by replacing label_1, label_2,...,label_n with your label categories.
{
\"document-version\": \"2018-11-28\"
\"labels\": [
{
\"label\": \"label_1\"
},
{
\"label\": \"label_2\"
},
...
{
\"label\": \"label_n\"
}
]
}
The S3 URI of the file that defines the categories used to label the data objects.
For 3D point cloud task types, see Create a Labeling Category Configuration File for 3D Point Cloud Labeling Jobs.
For all other built-in task types and custom tasks, your label category configuration file must be a JSON file in the following format. Identify the labels you want to use by replacing label_1, label_2,...,label_n with your label categories.
{
\"document-version\": \"2018-11-28\"
\"labels\": [
{
\"label\": \"label_1\"
},
{
\"label\": \"label_2\"
},
...
{
\"label\": \"label_n\"
}
]
}
Path to Amazon S3 storage location for tensors.
", "DebugRuleConfiguration$S3OutputPath": "Path to Amazon S3 storage location for rules.
", "DescribeLabelingJobResponse$LabelCategoryConfigS3Uri": "The S3 location of the JSON file that defines the categories used to label data objects. Please note the following label-category limits:
Semantic segmentation labeling jobs using automated labeling: 20 labels
Box bounding labeling jobs (all): 10 labels
The file is a JSON structure in the following format:
{
\"document-version\": \"2018-11-28\"
\"labels\": [
{
\"label\": \"label 1\"
},
{
\"label\": \"label 2\"
},
...
{
\"label\": \"label n\"
}
]
}
The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.
", "DescribeNotebookInstanceOutput$SecurityGroups": "The IDs of the VPC security groups.
", - "UserSettings$SecurityGroups": "The security groups.
" + "UserSettings$SecurityGroups": "The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly.
Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly.
The sort order for the results. The default is Ascending.
The sort order. The default value is Descending.
The sort order for the results. The default is Ascending.
", "ListCompilationJobsRequest$SortOrder": "The sort order for results. The default is Ascending.
The sort order. The default value is Descending.
An array of Tag objects. Each tag is a key-value pair. Only the key parameter is required. If you don't specify a value, Amazon SageMaker sets the value to an empty string.
A list of tags associated with the Amazon SageMaker resource.
", + "CreateAppImageConfigRequest$Tags": "A list of tags to apply to the AppImageConfig.
", "CreateAppRequest$Tags": "Each tag consists of a key and an optional value. Tag keys must be unique per resource.
", "CreateAutoMLJobRequest$Tags": "Each tag consists of a key and an optional value. Tag keys must be unique per resource.
", + "CreateCompilationJobRequest$Tags": "An array of key-value pairs that you want to use to organize and track your AWS resource costs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
", "CreateDomainRequest$Tags": "Tags to associated with the Domain. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.
", "CreateEndpointConfigInput$Tags": "A list of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
", "CreateEndpointInput$Tags": "An array of key-value pairs. For more information, see Using Cost Allocation Tagsin the AWS Billing and Cost Management User Guide.
", @@ -5642,6 +6064,7 @@ "CreateFlowDefinitionRequest$Tags": "An array of key-value pairs that contain metadata to help you categorize and organize a flow definition. Each tag consists of a key and a value, both of which you define.
", "CreateHumanTaskUiRequest$Tags": "An array of key-value pairs that contain metadata to help you categorize and organize a human review workflow user interface. Each tag consists of a key and a value, both of which you define.
", "CreateHyperParameterTuningJobRequest$Tags": "An array of key-value pairs. You can use tags to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. For more information, see AWS Tagging Strategies.
Tags that you specify for the tuning job are also added to all training jobs that the tuning job launches.
", + "CreateImageRequest$Tags": "A list of tags to apply to the image.
", "CreateLabelingJobRequest$Tags": "An array of key/value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
", "CreateModelInput$Tags": "An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
", "CreateMonitoringScheduleRequest$Tags": "(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
", @@ -5808,6 +6231,8 @@ "Timestamp": { "base": null, "refs": { + "AppImageConfigDetails$CreationTime": "When the AppImageConfig was created.
", + "AppImageConfigDetails$LastModifiedTime": "When the AppImageConfig was last modified.
", "AutoMLCandidate$CreationTime": "The creation time.
", "AutoMLCandidate$EndTime": "The end time.
", "AutoMLCandidate$LastModifiedTime": "The last modified time.
", @@ -5820,6 +6245,8 @@ "CreateTrialComponentRequest$EndTime": "When the component ended.
", "DebugRuleEvaluationStatus$LastModifiedTime": "Timestamp when the rule evaluation status was last modified.
", "DeployedImage$ResolutionTime": "The date and time when the image path for the model resolved to the ResolvedImage
When the AppImageConfig was created.
", + "DescribeAppImageConfigResponse$LastModifiedTime": "When the AppImageConfig was last modified.
", "DescribeAppResponse$LastHealthCheckTimestamp": "The timestamp of the last health check.
", "DescribeAppResponse$LastUserActivityTimestamp": "The timestamp of the last user's activity.
", "DescribeAutoMLJobResponse$CreationTime": "Returns the job's creation time.
", @@ -5837,6 +6264,10 @@ "DescribeHyperParameterTuningJobResponse$CreationTime": "The date and time that the tuning job started.
", "DescribeHyperParameterTuningJobResponse$HyperParameterTuningEndTime": "The date and time that the tuning job ended.
", "DescribeHyperParameterTuningJobResponse$LastModifiedTime": "The date and time that the status of the tuning job was modified.
", + "DescribeImageResponse$CreationTime": "When the image was created.
", + "DescribeImageResponse$LastModifiedTime": "When the image was last modified.
", + "DescribeImageVersionResponse$CreationTime": "When the version was created.
", + "DescribeImageVersionResponse$LastModifiedTime": "When the version was last modified.
", "DescribeLabelingJobResponse$CreationTime": "The date and time that the labeling job was created.
", "DescribeLabelingJobResponse$LastModifiedTime": "The date and time that the labeling job was last updated.
", "DescribeModelOutput$CreationTime": "A timestamp that shows when the model was created.
", @@ -5874,9 +6305,17 @@ "HyperParameterTuningJobSummary$CreationTime": "The date and time that the tuning job was created.
", "HyperParameterTuningJobSummary$HyperParameterTuningEndTime": "The date and time that the tuning job ended.
", "HyperParameterTuningJobSummary$LastModifiedTime": "The date and time that the tuning job was modified.
", + "Image$CreationTime": "When the image was created.
", + "Image$LastModifiedTime": "When the image was last modified.
", + "ImageVersion$CreationTime": "When the version was created.
", + "ImageVersion$LastModifiedTime": "When the version was last modified.
", "LabelingJobForWorkteamSummary$CreationTime": "The date and time that the labeling job was created.
", "LabelingJobSummary$CreationTime": "The date and time that the job was created (timestamp).
", "LabelingJobSummary$LastModifiedTime": "The date and time that the job was last modified (timestamp).
", + "ListAppImageConfigsRequest$CreationTimeBefore": "A filter that returns only AppImageConfigs created on or before the specified time.
", + "ListAppImageConfigsRequest$CreationTimeAfter": "A filter that returns only AppImageConfigs created on or after the specified time.
", + "ListAppImageConfigsRequest$ModifiedTimeBefore": "A filter that returns only AppImageConfigs modified on or before the specified time.
", + "ListAppImageConfigsRequest$ModifiedTimeAfter": "A filter that returns only AppImageConfigs modified on or after the specified time.
", "ListAutoMLJobsRequest$CreationTimeAfter": "Request a list of jobs, using a filter for time.
", "ListAutoMLJobsRequest$CreationTimeBefore": "Request a list of jobs, using a filter for time.
", "ListAutoMLJobsRequest$LastModifiedTimeAfter": "Request a list of jobs, using a filter for time.
", @@ -5899,6 +6338,14 @@ "ListHyperParameterTuningJobsRequest$CreationTimeBefore": "A filter that returns only tuning jobs that were created before the specified time.
", "ListHyperParameterTuningJobsRequest$LastModifiedTimeAfter": "A filter that returns only tuning jobs that were modified after the specified time.
", "ListHyperParameterTuningJobsRequest$LastModifiedTimeBefore": "A filter that returns only tuning jobs that were modified before the specified time.
", + "ListImageVersionsRequest$CreationTimeAfter": "A filter that returns only versions created on or after the specified time.
", + "ListImageVersionsRequest$CreationTimeBefore": "A filter that returns only versions created on or before the specified time.
", + "ListImageVersionsRequest$LastModifiedTimeAfter": "A filter that returns only versions modified on or after the specified time.
", + "ListImageVersionsRequest$LastModifiedTimeBefore": "A filter that returns only versions modified on or before the specified time.
", + "ListImagesRequest$CreationTimeAfter": "A filter that returns only images created on or after the specified time.
", + "ListImagesRequest$CreationTimeBefore": "A filter that returns only images created on or before the specified time.
", + "ListImagesRequest$LastModifiedTimeAfter": "A filter that returns only images modified on or after the specified time.
", + "ListImagesRequest$LastModifiedTimeBefore": "A filter that returns only images modified on or before the specified time.
", "ListLabelingJobsForWorkteamRequest$CreationTimeAfter": "A filter that returns only labeling jobs created after the specified time (timestamp).
", "ListLabelingJobsForWorkteamRequest$CreationTimeBefore": "A filter that returns only labeling jobs created before the specified time (timestamp).
", "ListLabelingJobsRequest$CreationTimeAfter": "A filter that returns only labeling jobs created after the specified time (timestamp).
", @@ -6480,6 +6927,16 @@ "DescribeHumanTaskUiResponse$UiTemplate": null } }, + "UpdateAppImageConfigRequest": { + "base": null, + "refs": { + } + }, + "UpdateAppImageConfigResponse": { + "base": null, + "refs": { + } + }, "UpdateCodeRepositoryInput": { "base": null, "refs": { @@ -6530,6 +6987,16 @@ "refs": { } }, + "UpdateImageRequest": { + "base": null, + "refs": { + } + }, + "UpdateImageResponse": { + "base": null, + "refs": { + } + }, "UpdateMonitoringScheduleRequest": { "base": null, "refs": { @@ -6737,6 +7204,14 @@ "ProductionVariantSummary$DesiredWeight": "The requested weight, as specified in the UpdateEndpointWeightsAndCapacities request.
The name or Amazon Resource Name (ARN) of the model package to use to create the model.
", + "DeleteModelPackageInput$ModelPackageName": "The name of the model package. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).
", + "DescribeModelPackageInput$ModelPackageName": "The name of the model package to describe.
" + } + }, "VolumeSizeInGB": { "base": null, "refs": { diff --git a/aws-sdk-core/apis/sagemaker/2017-07-24/paginators-1.json b/aws-sdk-core/apis/sagemaker/2017-07-24/paginators-1.json index 7f87ca77493..e4cb62d8038 100644 --- a/aws-sdk-core/apis/sagemaker/2017-07-24/paginators-1.json +++ b/aws-sdk-core/apis/sagemaker/2017-07-24/paginators-1.json @@ -78,6 +78,18 @@ "limit_key": "MaxResults", "result_key": "HyperParameterTuningJobSummaries" }, + "ListImageVersions": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "ImageVersions" + }, + "ListImages": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Images" + }, "ListLabelingJobs": { "input_token": "NextToken", "output_token": "NextToken", diff --git a/aws-sdk-core/endpoints.json b/aws-sdk-core/endpoints.json index 728bd1fc212..8fcd3e500f1 100644 --- a/aws-sdk-core/endpoints.json +++ b/aws-sdk-core/endpoints.json @@ -4632,6 +4632,12 @@ "region" : "us-east-1" }, "hostname" : "route53.amazonaws.com" + }, + "fips-aws-global" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "route53-fips.amazonaws.com" } }, "isRegionalized" : false, @@ -8263,6 +8269,12 @@ "region" : "us-gov-west-1" }, "hostname" : "route53.us-gov.amazonaws.com" + }, + "fips-aws-us-gov-global" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "route53.us-gov.amazonaws.com" } }, "isRegionalized" : false,