AssociateSbomWithPackageVersion
Associates the selected software bill of materials (SBOM) with a specific software package version.
Requires permission to access the AssociateSbomWithPackageVersion action.
Request Syntax
PUT /packages/packageName/versions/versionName/sbom?clientToken=clientToken HTTP/1.1
Content-type: application/json
{
"sbom": {
"s3Location": {
"bucket": "string",
"key": "string",
"version": "string"
}
}
}URI Request Parameters
The request uses the following URI parameters.
- clientToken
-
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
Length Constraints: Minimum length of 36. Maximum length of 64.
Pattern:
\S{36,64} - packageName
-
The name of the new software package.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9-_.]+Required: Yes
- versionName
-
The name of the new package version.
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9-_.]+Required: Yes
Request Body
The request accepts the following data in JSON format.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"packageName": "string",
"sbom": {
"s3Location": {
"bucket": "string",
"key": "string",
"version": "string"
}
},
"sbomValidationStatus": "string",
"versionName": "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.
- packageName
-
The name of the new software package.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9-_.]+ - sbom
-
A specific software bill of matrerials associated with a software package version.
Type: Sbom object
- sbomValidationStatus
-
The status of the initial validation for the software bill of materials against the Software Package Data Exchange (SPDX) and CycloneDX industry standard formats.
Type: String
Valid Values:
IN_PROGRESS | FAILED | SUCCEEDED - versionName
-
The name of the new package version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9-_.]+
Errors
- ConflictException
-
The request conflicts with the current state of the resource.
HTTP Status Code: 409
- InternalServerException
-
Internal error from the service that indicates an unexpected error or that the service is unavailable.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource does not exist.
HTTP Status Code: 404
- ServiceQuotaExceededException
-
Service quota has been exceeded.
HTTP Status Code: 402
- ThrottlingException
-
The rate exceeds the limit.
HTTP Status Code: 400
- ValidationException
-
The request is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
