ListDistributionConfigurations
Returns a list of distribution configurations.
Request Syntax
POST /ListDistributionConfigurations HTTP/1.1 Content-type: application/json
{ "filters": [ {
"name": "string", "values": [ "string" ] }
],
"maxResults": number, "nextToken": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
filters (p. 119)
You can filter on name to streamline results.
Type: Array of Filter (p. 224) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: No maxResults (p. 119)
The maximum items to return in a request.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 25.
Required: No nextToken (p. 119)
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 65535.
Required: No
Response Syntax
Response Syntax
HTTP/1.1 200
Content-type: application/json
{ "distributionConfigurationSummaryList": [ {
"arn": "string",
"dateCreated": "string", "dateUpdated": "string", "description": "string", "name": "string", "regions": [ "string" ], "tags": {
"string" : "string"
} } ],
"nextToken": "string", "requestId": "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.
distributionConfigurationSummaryList (p. 120) The list of distributions.
Type: Array of DistributionConfigurationSummary (p. 216) objects nextToken (p. 120)
The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 65535.
requestId (p. 120)
The request ID that uniquely identifies this request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 268).
CallRateLimitExceededException
You have exceeded the permitted request rate for the specific operation.
See Also
HTTP Status Code: 429 ClientException
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
HTTP Status Code: 400 ForbiddenException
You are not authorized to perform the requested operation.
HTTP Status Code: 403 InvalidPaginationTokenException
You have provided an invalid pagination token in your request.
HTTP Status Code: 400 InvalidRequestException
You have made a request for an action that is not supported by the service.
HTTP Status Code: 400 ServiceException
This exception is thrown when the service encounters an unrecoverable exception.
HTTP Status Code: 500 ServiceUnavailableException
The service is unable to process your request at this time.
HTTP Status Code: 503
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListImageBuildVersions
ListImageBuildVersions
Returns a list of image build versions.
Request Syntax
POST /ListImageBuildVersions HTTP/1.1 Content-type: application/json { "filters": [
{
"name": "string", "values": [ "string" ] }
],
"imageVersionArn": "string", "maxResults": number, "nextToken": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
filters (p. 122)
Use the following filters to streamline results:
• name
• osVersion
• platform
• type
• version
Type: Array of Filter (p. 224) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: No
imageVersionArn (p. 122)
The Amazon Resource Name (ARN) of the image whose build versions you want to retrieve.
Type: String
Pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):image/[a-z0-9-_]+/
[0-9]+\.[0-9]+\.[0-9]+$
Required: Yes maxResults (p. 122)
The maximum items to return in a request.
Response Syntax
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 25.
Required: No nextToken (p. 122)
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 65535.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json {
"imageSummaryList": [ {
Response Elements
],
"nextToken": "string", "requestId": "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.
imageSummaryList (p. 123) The list of image build versions.
Type: Array of ImageSummary (p. 239) objects nextToken (p. 123)
The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 65535.
requestId (p. 123)
The request ID that uniquely identifies this request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 268).
CallRateLimitExceededException
You have exceeded the permitted request rate for the specific operation.
HTTP Status Code: 429 ClientException
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
HTTP Status Code: 400 ForbiddenException
You are not authorized to perform the requested operation.
HTTP Status Code: 403 InvalidPaginationTokenException
You have provided an invalid pagination token in your request.
See Also
HTTP Status Code: 400 InvalidRequestException
You have made a request for an action that is not supported by the service.
HTTP Status Code: 400 ServiceException
This exception is thrown when the service encounters an unrecoverable exception.
HTTP Status Code: 500 ServiceUnavailableException
The service is unable to process your request at this time.
HTTP Status Code: 503
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListImagePackages
ListImagePackages
List the Packages that are associated with an Image Build Version, as determined by AWS Systems Manager Inventory at build time.
Request Syntax
POST /ListImagePackages HTTP/1.1 Content-type: application/json {
"imageBuildVersionArn": "string", "maxResults": number,
"nextToken": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
imageBuildVersionArn (p. 126)
Filter results for the ListImagePackages request by the Image Build Version ARN Type: String
Pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):image/[a-z0-9-_]+/
[0-9]+\.[0-9]+\.[0-9]+/[0-9]+$
Required: Yes maxResults (p. 126)
The maxiumum number of results to return from the ListImagePackages request.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 25.
Required: No nextToken (p. 126)
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 65535.
Required: No
Response Syntax
HTTP/1.1 200
Response Elements
Content-type: application/json { "imagePackageList": [ {
"packageName": "string", "packageVersion": "string"
} ],
"nextToken": "string", "requestId": "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.
imagePackageList (p. 126)
The list of Image Packages returned in the response.
Type: Array of ImagePackage (p. 229) objects nextToken (p. 126)
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 65535.
requestId (p. 126)
The request ID that uniquely identifies this request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 268).
CallRateLimitExceededException
You have exceeded the permitted request rate for the specific operation.
HTTP Status Code: 429 ClientException
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
HTTP Status Code: 400 ForbiddenException
You are not authorized to perform the requested operation.
See Also
HTTP Status Code: 403 InvalidPaginationTokenException
You have provided an invalid pagination token in your request.
HTTP Status Code: 400 InvalidRequestException
You have made a request for an action that is not supported by the service.
HTTP Status Code: 400 ResourceNotFoundException
At least one of the resources referenced by your request does not exist.
HTTP Status Code: 404 ServiceException
This exception is thrown when the service encounters an unrecoverable exception.
HTTP Status Code: 500 ServiceUnavailableException
The service is unable to process your request at this time.
HTTP Status Code: 503
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListImagePipelineImages
ListImagePipelineImages
Returns a list of images created by the specified pipeline.
Request Syntax
POST /ListImagePipelineImages HTTP/1.1 Content-type: application/json
{ "filters": [ {
"name": "string", "values": [ "string" ] }
],
"imagePipelineArn": "string", "maxResults": number,
"nextToken": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
filters (p. 129)
Use the following filters to streamline results:
• name
• version
Type: Array of Filter (p. 224) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: No
imagePipelineArn (p. 129)
The Amazon Resource Name (ARN) of the image pipeline whose images you want to view.
Type: String
Pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):image-pipeline/[a-z0-9-_]+$
Required: Yes maxResults (p. 129)
The maximum items to return in a request.
Type: Integer
Response Syntax
Valid Range: Minimum value of 1. Maximum value of 25.
Required: No nextToken (p. 129)
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 65535.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json {
"imageSummaryList": [ {
"nextToken": "string",
Response Elements
"requestId": "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.
imageSummaryList (p. 130)
The list of images built by this pipeline.
Type: Array of ImageSummary (p. 239) objects nextToken (p. 130)
The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 65535.
requestId (p. 130)
The request ID that uniquely identifies this request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 268).
CallRateLimitExceededException
You have exceeded the permitted request rate for the specific operation.
HTTP Status Code: 429 ClientException
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
HTTP Status Code: 400 ForbiddenException
You are not authorized to perform the requested operation.
HTTP Status Code: 403 InvalidPaginationTokenException
You have provided an invalid pagination token in your request.
HTTP Status Code: 400
See Also
InvalidRequestException
You have made a request for an action that is not supported by the service.
HTTP Status Code: 400 ResourceNotFoundException
At least one of the resources referenced by your request does not exist.
HTTP Status Code: 404 ServiceException
This exception is thrown when the service encounters an unrecoverable exception.
HTTP Status Code: 500 ServiceUnavailableException
The service is unable to process your request at this time.
HTTP Status Code: 503
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListImagePipelines
ListImagePipelines
Returns a list of image pipelines.
Request Syntax
POST /ListImagePipelines HTTP/1.1 Content-type: application/json { "filters": [
{
"name": "string", "values": [ "string" ] }
],
"maxResults": number, "nextToken": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
filters (p. 133)
Use the following filters to streamline results:
• description
• distributionConfigurationArn
• imageRecipeArn
• infrastructureConfigurationArn
• name
• status
Type: Array of Filter (p. 224) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: No maxResults (p. 133)
The maximum items to return in a request.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 25.
Required: No
Response Syntax
nextToken (p. 133)
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 65535.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json { "imagePipelineList": [ {
"distributionConfigurationArn": "string", "enhancedImageMetadataEnabled": boolean, "imageRecipeArn": "string",
"imageTestsConfiguration": { "imageTestsEnabled": boolean, "timeoutMinutes": number },
"infrastructureConfigurationArn": "string", "name": "string",
"platform": "string", "schedule": {
"pipelineExecutionStartCondition": "string", "scheduleExpression": "string",
"nextToken": "string", "requestId": "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.
imagePipelineList (p. 134) The list of image pipelines.
Errors
Type: Array of ImagePipeline (p. 230) objects nextToken (p. 134)
The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 65535.
requestId (p. 134)
The request ID that uniquely identifies this request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 268).
CallRateLimitExceededException
You have exceeded the permitted request rate for the specific operation.
HTTP Status Code: 429 ClientException
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
HTTP Status Code: 400 ForbiddenException
You are not authorized to perform the requested operation.
HTTP Status Code: 403 InvalidPaginationTokenException
You have provided an invalid pagination token in your request.
HTTP Status Code: 400 InvalidRequestException
You have made a request for an action that is not supported by the service.
HTTP Status Code: 400 ServiceException
This exception is thrown when the service encounters an unrecoverable exception.
HTTP Status Code: 500 ServiceUnavailableException
The service is unable to process your request at this time.
See Also
HTTP Status Code: 503
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListImageRecipes
ListImageRecipes
Returns a list of image recipes.
Request Syntax
POST /ListImageRecipes HTTP/1.1 Content-type: application/json { "filters": [
{
"name": "string", "values": [ "string" ] }
],
"maxResults": number, "nextToken": "string", "owner": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
filters (p. 137)
Use the following filters to streamline results:
• name
• parentImage
• platform
Type: Array of Filter (p. 224) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: No maxResults (p. 137)
The maximum items to return in a request.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 25.
Required: No nextToken (p. 137)
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
Type: String
Response Syntax
Length Constraints: Minimum length of 1. Maximum length of 65535.
Required: No owner (p. 137)
The owner defines which image recipes you want to list. By default, this request will only show image recipes owned by your account. You can use this field to specify if you want to view image recipes owned by yourself, by Amazon, or those image recipes that have been shared with you by other customers.
Type: String
Valid Values: Self | Shared | Amazon Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json {
"imageRecipeSummaryList": [ {
"nextToken": "string", "requestId": "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.
imageRecipeSummaryList (p. 138) The list of image pipelines.
Type: Array of ImageRecipeSummary (p. 236) objects nextToken (p. 138)
The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 65535.
Errors
requestId (p. 138)
The request ID that uniquely identifies this request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 268).
CallRateLimitExceededException
You have exceeded the permitted request rate for the specific operation.
HTTP Status Code: 429 ClientException
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
HTTP Status Code: 400 ForbiddenException
You are not authorized to perform the requested operation.
HTTP Status Code: 403 InvalidPaginationTokenException
You have provided an invalid pagination token in your request.
HTTP Status Code: 400 InvalidRequestException
You have made a request for an action that is not supported by the service.
HTTP Status Code: 400 ServiceException
This exception is thrown when the service encounters an unrecoverable exception.
HTTP Status Code: 500 ServiceUnavailableException
The service is unable to process your request at this time.
HTTP Status Code: 503
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
See Also
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListImages
ListImages
Returns the list of images that you have access to.
Request Syntax
POST /ListImages HTTP/1.1 Content-type: application/json { "byName": boolean,
"filters": [ {
"name": "string", "values": [ "string" ] }
],
"includeDeprecated": boolean, "maxResults": number,
"nextToken": "string", "owner": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
byName (p. 141)
Requests a list of images with a specific recipe name.
Type: Boolean Required: No filters (p. 141)
Use the following filters to streamline results:
• name
• osVersion
• platform
• type
• version
Type: Array of Filter (p. 224) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: No
includeDeprecated (p. 141)
Includes deprecated images in the response list.
Type: Boolean
Response Syntax
Required: No maxResults (p. 141)
The maximum items to return in a request.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 25.
Required: No nextToken (p. 141)
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 65535.
Required: No owner (p. 141)
The owner defines which images you want to list. By default, this request will only show images owned by your account. You can use this field to specify if you want to view images owned by yourself, by Amazon, or those images that have been shared with you by other customers.
Type: String
Valid Values: Self | Shared | Amazon Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json {
"imageVersionList": [ {
"nextToken": "string", "requestId": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
Errors
The following data is returned in JSON format by the service.
The following data is returned in JSON format by the service.