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.
Request Syntax
{
"CreationTimeAfter": number
,
"CreationTimeBefore": number
,
"MaxResults": number
,
"ModifiedTimeAfter": number
,
"ModifiedTimeBefore": number
,
"NameContains": "string
",
"NextToken": "string
",
"SortBy": "string
",
"SortOrder": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- CreationTimeAfter
-
A filter that returns only AppImageConfigs created on or after the specified time.
Type: Timestamp
Required: No
- CreationTimeBefore
-
A filter that returns only AppImageConfigs created on or before the specified time.
Type: Timestamp
Required: No
- MaxResults
-
The total number of items to return in the response. If the total number of items available is more than the value specified, a
NextToken
is provided in the response. To resume pagination, provide theNextToken
value in the as part of a subsequent call. The default value is 10.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- ModifiedTimeAfter
-
A filter that returns only AppImageConfigs modified on or after the specified time.
Type: Timestamp
Required: No
- ModifiedTimeBefore
-
A filter that returns only AppImageConfigs modified on or before the specified time.
Type: Timestamp
Required: No
- NameContains
-
A filter that returns only AppImageConfigs whose name contains the specified string.
Type: String
Length Constraints: Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}
Required: No
- 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.Type: String
Length Constraints: Maximum length of 8192.
Pattern:
.*
Required: No
- SortBy
-
The property used to sort results. The default value is
CreationTime
.Type: String
Valid Values:
CreationTime | LastModifiedTime | Name
Required: No
- SortOrder
-
The sort order. The default value is
Descending
.Type: String
Valid Values:
Ascending | Descending
Required: No
Response Syntax
{
"AppImageConfigs": [
{
"AppImageConfigArn": "string",
"AppImageConfigName": "string",
"CodeEditorAppImageConfig": {
"ContainerConfig": {
"ContainerArguments": [ "string" ],
"ContainerEntrypoint": [ "string" ],
"ContainerEnvironmentVariables": {
"string" : "string"
}
},
"FileSystemConfig": {
"DefaultGid": number,
"DefaultUid": number,
"MountPath": "string"
}
},
"CreationTime": number,
"JupyterLabAppImageConfig": {
"ContainerConfig": {
"ContainerArguments": [ "string" ],
"ContainerEntrypoint": [ "string" ],
"ContainerEnvironmentVariables": {
"string" : "string"
}
},
"FileSystemConfig": {
"DefaultGid": number,
"DefaultUid": number,
"MountPath": "string"
}
},
"KernelGatewayImageConfig": {
"FileSystemConfig": {
"DefaultGid": number,
"DefaultUid": number,
"MountPath": "string"
},
"KernelSpecs": [
{
"DisplayName": "string",
"Name": "string"
}
]
},
"LastModifiedTime": number
}
],
"NextToken": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- AppImageConfigs
-
A list of AppImageConfigs and their properties.
Type: Array of AppImageConfigDetails objects
- NextToken
-
A token for getting the next set of AppImageConfigs, if there are any.
Type: String
Length Constraints: Maximum length of 8192.
Pattern:
.*
Errors
For information about the errors that are common to all actions, see Common Errors.
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: