ListRepositorySyncDefinitions
List repository sync definitions with detail data.
Request Syntax
{
"nextToken": "string", "repositoryName": "string", "repositoryProvider": "string", "syncType": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 278).
The request accepts the following data in JSON format.
nextToken (p. 132)
A token that indicates the location of the next repository sync definition in the array of repository sync definitions, after the list of repository sync definitions previously requested.
Type: String
Length Constraints: Fixed length of 0.
Required: No repositoryName (p. 132)
The repository name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: [A-Za-z0-9_.-].*/[A-Za-z0-9_.-].*
Required: Yes
repositoryProvider (p. 132) The repository provider.
Type: String
Valid Values: GITHUB | GITHUB_ENTERPRISE | BITBUCKET Required: Yes
syncType (p. 132)
The sync type. The only supported value is TEMPLATE_SYNC.
Type: String
Valid Values: TEMPLATE_SYNC
Response Syntax
Required: Yes
Response Syntax
{ "nextToken": "string", "syncDefinitions": [ {
"branch": "string", "directory": "string", "parent": "string", "target": "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.
nextToken (p. 133)
A token that indicates the location of the next repository sync definition in the array of repository sync definitions, after the current requested list of repository sync definitions.
Type: String
Length Constraints: Fixed length of 0.
syncDefinitions (p. 133)
An array of repository sync definitions.
Type: Array of RepositorySyncDefinition (p. 244) objects
Errors
For information about the errors that are common to all actions, see Common Errors (p. 280).
AccessDeniedException
There isn't sufficient access for performing this action.
HTTP Status Code: 400 InternalServerException
The request failed to register with the service.
HTTP Status Code: 500 ThrottlingException
The request was denied due to request throttling.
HTTP Status Code: 400
See Also
ValidationException
The input is invalid or an out-of-range value was supplied for the input parameter.
HTTP Status Code: 400
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
ListServiceInstanceOutputs
ListServiceInstanceOutputs
View a list service instance infrastructure as code outputs with detail data.
Request Syntax
{
"nextToken": "string",
"serviceInstanceName": "string", "serviceName": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 278).
The request accepts the following data in JSON format.
nextToken (p. 135)
A token that indicates the location of the next output in the array of outputs, after the list of outputs that was previously requested.
Type: String
Length Constraints: Fixed length of 0.
Required: No
serviceInstanceName (p. 135) The service instance name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$
Required: Yes serviceName (p. 135)
The service name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$
Required: Yes
Response Syntax
{
Response Elements
"nextToken": "string", "outputs": [
{
"key": "string",
"valueString": "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.
nextToken (p. 135)
A token that indicates the location of the next output in the array of outputs, after the current requested list of outputs.
Type: String
Length Constraints: Fixed length of 0.
outputs (p. 135)
An array of service instance infrastructure as code outputs.
Type: Array of Output (p. 235) objects
Errors
For information about the errors that are common to all actions, see Common Errors (p. 280).
AccessDeniedException
There isn't sufficient access for performing this action.
HTTP Status Code: 400 InternalServerException
The request failed to register with the service.
HTTP Status Code: 500 ResourceNotFoundException
The requested resource wasn't found.
HTTP Status Code: 400 ThrottlingException
The request was denied due to request throttling.
HTTP Status Code: 400 ValidationException
The input is invalid or an out-of-range value was supplied for the input parameter.
HTTP Status Code: 400
See Also
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
ListServiceInstanceProvisionedResources
ListServiceInstanceProvisionedResources
List provisioned resources for a service instance with details.
Request Syntax
{
"nextToken": "string",
"serviceInstanceName": "string", "serviceName": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 278).
The request accepts the following data in JSON format.
nextToken (p. 138)
A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the list of provisioned resources that was previously requested.
Type: String
Length Constraints: Fixed length of 0.
Required: No
serviceInstanceName (p. 138) The service instance name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$
Required: Yes serviceName (p. 138)
The service name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$
Required: Yes
Response Syntax
{
Response Elements
"nextToken": "string", "provisionedResources": [ {
"identifier": "string", "name": "string",
"provisioningEngine": "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.
nextToken (p. 138)
A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the current requested list of provisioned resources.
Type: String
Length Constraints: Fixed length of 0.
provisionedResources (p. 138)
An array of provisioned resources for a service instance.
Type: Array of ProvisionedResource (p. 236) objects
Errors
For information about the errors that are common to all actions, see Common Errors (p. 280).
AccessDeniedException
There isn't sufficient access for performing this action.
HTTP Status Code: 400 InternalServerException
The request failed to register with the service.
HTTP Status Code: 500 ResourceNotFoundException
The requested resource wasn't found.
HTTP Status Code: 400 ThrottlingException
The request was denied due to request throttling.
HTTP Status Code: 400 ValidationException
The input is invalid or an out-of-range value was supplied for the input parameter.
See Also
HTTP Status Code: 400
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
ListServiceInstances
ListServiceInstances
List service instances with summaries of detail data.
Request Syntax
{
"maxResults": number, "nextToken": "string", "serviceName": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 278).
The request accepts the following data in JSON format.
maxResults (p. 141)
The maximum number of service instances to list.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No nextToken (p. 141)
A token that indicates the location of the next service in the array of service instances, after the list of service instances that was previously requested.
Type: String
Pattern: ^[A-Za-z0-9+=/]+$
Required: No serviceName (p. 141)
The name of the service that the service instance belongs to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$
Required: No
Response Syntax
{ "nextToken": "string", "serviceInstances": [ {
Response Elements
"arn": "string", "createdAt": number,
"deploymentStatus": "string", "deploymentStatusMessage": "string", "environmentName": "string",
"lastDeploymentAttemptedAt": number, "lastDeploymentSucceededAt": number, "name": "string",
"serviceName": "string",
"templateMajorVersion": "string", "templateMinorVersion": "string", "templateName": "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.
nextToken (p. 141)
A token that indicates the location of the next service instance in the array of service instances, after the current requested list of service instances.
Type: String
Pattern: ^[A-Za-z0-9+=/]+$
serviceInstances (p. 141)
An array of service instances with summaries of detail data.
Type: Array of ServiceInstanceSummary (p. 258) objects
Errors
For information about the errors that are common to all actions, see Common Errors (p. 280).
AccessDeniedException
There isn't sufficient access for performing this action.
HTTP Status Code: 400 InternalServerException
The request failed to register with the service.
HTTP Status Code: 500 ResourceNotFoundException
The requested resource wasn't found.
HTTP Status Code: 400 ThrottlingException
The request was denied due to request throttling.
See Also
HTTP Status Code: 400 ValidationException
The input is invalid or an out-of-range value was supplied for the input parameter.
HTTP Status Code: 400
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
ListServicePipelineOutputs
ListServicePipelineOutputs
View a list service pipeline infrastructure as code outputs with detail.
Request Syntax
{ "nextToken": "string", "serviceName": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 278).
The request accepts the following data in JSON format.
nextToken (p. 144)
A token that indicates the location of the next output in the array of outputs, after the list of outputs that was previously requested.
Type: String
Length Constraints: Fixed length of 0.
Required: No serviceName (p. 144)
The service name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$
Required: Yes
Response Syntax
{
"nextToken": "string", "outputs": [
{
"key": "string",
"valueString": "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.
nextToken (p. 144)
A token that indicates the location of the next output in the array of outputs, after the current requested list of outputs.
Type: String
Length Constraints: Fixed length of 0.
outputs (p. 144) An array of outputs.
Type: Array of Output (p. 235) objects
Errors
For information about the errors that are common to all actions, see Common Errors (p. 280).
AccessDeniedException
There isn't sufficient access for performing this action.
HTTP Status Code: 400 InternalServerException
The request failed to register with the service.
HTTP Status Code: 500 ResourceNotFoundException
The requested resource wasn't found.
HTTP Status Code: 400 ThrottlingException
The request was denied due to request throttling.
HTTP Status Code: 400 ValidationException
The input is invalid or an out-of-range value was supplied for the input parameter.
HTTP Status Code: 400
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
See Also
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListServicePipelineProvisionedResources
ListServicePipelineProvisionedResources
List provisioned resources for a service and pipeline with details.
Request Syntax
{ "nextToken": "string", "serviceName": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 278).
The request accepts the following data in JSON format.
nextToken (p. 147)
A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the list of provisioned resources that was previously requested.
Type: String
Length Constraints: Fixed length of 0.
Required: No serviceName (p. 147)
The service name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$
Required: Yes
Response Syntax
{ "nextToken": "string", "provisionedResources": [ {
"identifier": "string", "name": "string",
"provisioningEngine": "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.
nextToken (p. 147)
A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the current requested list of provisioned resources.
Type: String
Length Constraints: Fixed length of 0.
provisionedResources (p. 147)
An array of provisioned resources for a service and pipeline.
Type: Array of ProvisionedResource (p. 236) objects
Errors
For information about the errors that are common to all actions, see Common Errors (p. 280).
AccessDeniedException
There isn't sufficient access for performing this action.
HTTP Status Code: 400 InternalServerException
The request failed to register with the service.
HTTP Status Code: 500 ResourceNotFoundException
The requested resource wasn't found.
HTTP Status Code: 400 ThrottlingException
The request was denied due to request throttling.
HTTP Status Code: 400 ValidationException
The input is invalid or an out-of-range value was supplied for the input parameter.
HTTP Status Code: 400
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
See Also
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListServices
ListServices
List services with summaries of detail data.
Request Syntax
{
"maxResults": number, "nextToken": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 278).
The request accepts the following data in JSON format.
maxResults (p. 150)
The maximum number of services to list.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No nextToken (p. 150)
A token that indicates the location of the next service in the array of services, after the list of services that was previously requested.
Type: String
Pattern: ^[A-Za-z0-9+=/]+$
Required: No
Response Syntax
{ "nextToken": "string", "services": [
Response Elements
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.
nextToken (p. 150)
A token that indicates the location of the next service in the array of services, after the current requested list of services.
Type: String
Pattern: ^[A-Za-z0-9+=/]+$
services (p. 150)
An array of services with summaries of detail data.
Type: Array of ServiceSummary (p. 263) objects
Errors
For information about the errors that are common to all actions, see Common Errors (p. 280).
AccessDeniedException
There isn't sufficient access for performing this action.
HTTP Status Code: 400 InternalServerException
The request failed to register with the service.
HTTP Status Code: 500 ThrottlingException
The request was denied due to request throttling.
HTTP Status Code: 400 ValidationException
The input is invalid or an out-of-range value was supplied for the input parameter.
HTTP Status Code: 400
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
See Also
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListServiceTemplates
ListServiceTemplates
List service templates with detail data.
Request Syntax
{
"maxResults": number, "nextToken": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 278).
The request accepts the following data in JSON format.
maxResults (p. 153)
The maximum number of service templates to list.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No nextToken (p. 153)
A token that indicates the location of the next service template in the array of service templates, after the list of service templates previously requested.
Type: String
Pattern: ^[A-Za-z0-9+=/]+$
Required: No
Response Syntax
{ "nextToken": "string", "templates": [
"pipelineProvisioning": "string", "recommendedVersion": "string"
} ]}
Response Elements
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.
nextToken (p. 153)
A token that indicates the location of the next service template in the array of service templates, after the current requested list of service templates.
Type: String
Pattern: ^[A-Za-z0-9+=/]+$
templates (p. 153)
An array of service templates with detail data.
Type: Array of ServiceTemplateSummary (p. 267) objects
Errors
For information about the errors that are common to all actions, see Common Errors (p. 280).
AccessDeniedException
There isn't sufficient access for performing this action.
HTTP Status Code: 400 InternalServerException
The request failed to register with the service.
HTTP Status Code: 500 ThrottlingException
The request was denied due to request throttling.
HTTP Status Code: 400 ValidationException
The input is invalid or an out-of-range value was supplied for the input parameter.
HTTP Status Code: 400
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
See Also
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListServiceTemplateVersions
ListServiceTemplateVersions
List major or minor versions of a service template with detail data.
Request Syntax
{ "majorVersion": "string", "maxResults": number, "nextToken": "string", "templateName": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 278).
The request accepts the following data in JSON format.
majorVersion (p. 156)
To view a list of minor of versions under a major version of a service template, include major Version.
To view a list of major versions of a service template, exclude major Version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern: ^(0|([1-9]{1}\d*))$
Required: No maxResults (p. 156)
The maximum number of major or minor versions of a service template to list.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No nextToken (p. 156)
A token that indicates the location of the next major or minor version in the array of major or minor versions of a service template, after the list of major or minor versions that was previously requested.
Type: String
Pattern: ^[A-Za-z0-9+=/]+$
Required: No templateName (p. 156)
The name of the service template.
Response Syntax
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$
Required: Yes
Response Syntax
{
"nextToken": "string", "templateVersions": [ {
"recommendedMinorVersion": "string", "status": "string",
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
nextToken (p. 157)
A token that indicates the location of the next major or minor version in the array of major or minor versions of a service template, after the current requested list of service major or minor versions.
Type: String
Pattern: ^[A-Za-z0-9+=/]+$
templateVersions (p. 157)
An array of major or minor versions of a service template with detail data.
Type: Array of ServiceTemplateVersionSummary (p. 272) objects
Errors
For information about the errors that are common to all actions, see Common Errors (p. 280).
AccessDeniedException
There isn't sufficient access for performing this action.
HTTP Status Code: 400
See Also
InternalServerException
The request failed to register with the service.
HTTP Status Code: 500 ResourceNotFoundException
The requested resource wasn't found.
HTTP Status Code: 400 ThrottlingException
The request was denied due to request throttling.
HTTP Status Code: 400 ValidationException
The input is invalid or an out-of-range value was supplied for the input parameter.
HTTP Status Code: 400
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
ListTagsForResource
ListTagsForResource
List tags for a resource. For more information, see AWS Proton resources and tagging in the AWS Proton Administrator Guide or AWS Proton User Guide.
Request Syntax
{ "maxResults": number, "nextToken": "string", "resourceArn": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 278).
The request accepts the following data in JSON format.
maxResults (p. 159)
The maximum number of tags to list.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No nextToken (p. 159)
A token that indicates the location of the next resource tag in the array of resource tags, after the list of resource tags that was previously requested.
Type: String Required: No resourceArn (p. 159)
The Amazon Resource Name (ARN) of the resource for the listed tags.
The Amazon Resource Name (ARN) of the resource for the listed tags.