EcsService
Bases: DuploResourceV2
Manage Duplo ECS Resources
A collection of commands to manage ECS services and task definitions.
Commands
apply
Apply an ECS Service.
Create or update an ECS service.
Returns:
| Name | Type | Description |
|---|---|---|
message |
dict
|
A success message. |
Model: AwsAmazonECSRequest
{
"description": "AwsAmazonECSRequest",
"properties": {},
"title": "AwsAmazonECSRequest",
"type": "object"
}Parameters:
--file, -f, --cli-input
A file to read the input from
--wait, -w
Wait for the operation to complete
create_service
Create an ECS service.
Returns:
| Name | Type | Description |
|---|---|---|
message |
dict
|
A success message. |
Raises:
| Type | Description |
|---|---|
DuploError
|
If the ECS service could not be created. |
Model: AwsAmazonECSRequest
{
"description": "AwsAmazonECSRequest",
"properties": {},
"title": "AwsAmazonECSRequest",
"type": "object"
}Parameters:
--file, -f, --cli-input
A file to read the input from
delete_service
Delete an ECS service.
Returns:
| Name | Type | Description |
|---|---|---|
message |
dict
|
A message indicating the service has been deleted. |
Parameters:
name
positional
The resource name
find
find_def
Find the latest version of an ECS task definition by family name.
Returns:
| Name | Type | Description |
|---|---|---|
task_definition |
The latest version of that ECS task definition in the family. |
Raises:
| Type | Description |
|---|---|
DuploError
|
If the ECS task definition could not be found. |
Parameters:
name
positional
The resource name
find_def_by_arn
Find a ECS task definition by ARN.
Find a task definition by its AWS ARN.
Returns:
| Name | Type | Description |
|---|---|---|
task_definition |
dict
|
The ECS task definition object. |
Raises:
| Type | Description |
|---|---|
DuploError
|
If the ECS task definition could not be found. |
Parameters:
--aws-arn, --arn
The aws arn
find_service_family
Find Service Family by Name
Find an ECS Services task definition family by name.
Returns:
| Name | Type | Description |
|---|---|---|
task_definition_family |
The ECS task definition object. |
Raises:
| Type | Description |
|---|---|
DuploError
|
If the ECS task definition could not be found. |
Parameters:
name
positional
The resource name
find_task_def_family
Find a ECS task definition family by name.
Returns:
| Type | Description |
|---|---|
|
The ECS task definition object. |
Raises:
| Type | Description |
|---|---|
DuploError
|
If the ECS task definition could not be found. |
Parameters:
name
positional
The resource name
list
list_services
list_task_def_family
list_tasks
run_task
Run a task from an ECS task definition family's latest definition version."
Execute a task based on some definition.
Wait for task to complete
This supports the global --wait flag to hold the terminal until the task is complete.
Waits for the status of the task to be the desired complete status.
Returns:
| Name | Type | Description |
|---|---|---|
message |
dict
|
A message indicating the task has been run. |
Parameters:
name
positional
The resource name
--replicas, -r
Number of replicas for service
update_image
Update Image
Creates a new task definition version cloning the latest existing version in the family except for image arguments
If task family is used by an ECS service, method also updates the service to use that newly created definition version
Basic CLI Use
Update image and wait
This supports the global --wait flag to hold the terminal until the service update is complete.
Waits for the status of the service to be the desired running status.
Returns:
| Name | Type | Description |
|---|---|---|
dict |
dict
|
A dictionary containing a message about the update status. |
Raises:
| Type | Description |
|---|---|
DuploError
|
If the ECS task definition family could not be updated. |
Parameters:
name
positional
The resource name
image
positional
The image to use
--container-image, --container-image
repeatable
a key and value to set as a side-car container name and image
update_service
Update an ECS service.
Returns:
| Name | Type | Description |
|---|---|---|
message |
dict
|
A success message. |
Raises:
| Type | Description |
|---|---|
DuploError
|
If the ECS service could not be updated. |
Model: AwsAmazonECSRequest
{
"description": "AwsAmazonECSRequest",
"properties": {},
"title": "AwsAmazonECSRequest",
"type": "object"
}Parameters:
--file, -f, --cli-input
A file to read the input from
update_taskdef
Update an ECS task definition.
Updates a task definition. This creates a new revision of the task definition and returns the new ARN. Note each definition is immutable so this is effectively a create operation for one item in a set and the latest one is the active one.
Returns:
| Name | Type | Description |
|---|---|---|
task_definition |
dict
|
The updated ECS task definition object. |
Raises:
| Type | Description |
|---|---|
DuploError
|
If the ECS task definition could not be updated. |
Model: AwsRegisterTaskDefinitionRequest
{
"$defs": {
"AwsApplicationProtocol": {
"description": "AwsApplicationProtocol",
"properties": {
"Value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
}
},
"title": "AwsApplicationProtocol",
"type": "object"
},
"AwsCPUArchitecture": {
"description": "AwsCPUArchitecture",
"properties": {
"Value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
}
},
"title": "AwsCPUArchitecture",
"type": "object"
},
"AwsContainerCondition": {
"description": "AwsContainerCondition",
"properties": {
"Value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
}
},
"title": "AwsContainerCondition",
"type": "object"
},
"AwsContainerDefinition": {
"description": "AwsContainerDefinition",
"properties": {
"Command": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Command"
},
"Cpu": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Cpu"
},
"CredentialSpecs": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Credentialspecs"
},
"DependsOn": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/AwsContainerDependency"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Dependson"
},
"DisableNetworking": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Disablenetworking"
},
"DnsSearchDomains": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Dnssearchdomains"
},
"DnsServers": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Dnsservers"
},
"DockerLabels": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Dockerlabels"
},
"DockerSecurityOptions": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Dockersecurityoptions"
},
"EntryPoint": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Entrypoint"
},
"Environment": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/AwsKeyValuePair"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Environment"
},
"EnvironmentFiles": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/AwsEnvironmentFile"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Environmentfiles"
},
"Essential": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Essential"
},
"ExtraHosts": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/AwsHostEntry"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Extrahosts"
},
"FirelensConfiguration": {
"anyOf": [
{
"$ref": "#/$defs/AwsFirelensConfiguration"
},
{
"type": "null"
}
],
"default": null
},
"HealthCheck": {
"anyOf": [
{
"$ref": "#/$defs/AwsHealthCheck"
},
{
"type": "null"
}
],
"default": null
},
"Hostname": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Hostname"
},
"Image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Image"
},
"Interactive": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Interactive"
},
"Links": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Links"
},
"LinuxParameters": {
"anyOf": [
{
"$ref": "#/$defs/AwsLinuxParameters"
},
{
"type": "null"
}
],
"default": null
},
"LogConfiguration": {
"anyOf": [
{
"$ref": "#/$defs/AwsLogConfiguration"
},
{
"type": "null"
}
],
"default": null
},
"Memory": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Memory"
},
"MemoryReservation": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Memoryreservation"
},
"MountPoints": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/AwsMountPoint"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Mountpoints"
},
"Name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"PortMappings": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/AwsPortMapping"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Portmappings"
},
"Privileged": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Privileged"
},
"PseudoTerminal": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Pseudoterminal"
},
"ReadonlyRootFilesystem": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Readonlyrootfilesystem"
},
"RepositoryCredentials": {
"anyOf": [
{
"$ref": "#/$defs/AwsRepositoryCredentials"
},
{
"type": "null"
}
],
"default": null
},
"ResourceRequirements": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/AwsResourceRequirement"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Resourcerequirements"
},
"RestartPolicy": {
"anyOf": [
{
"$ref": "#/$defs/AwsContainerRestartPolicy"
},
{
"type": "null"
}
],
"default": null
},
"Secrets": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/AwsSecret"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Secrets"
},
"StartTimeout": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Starttimeout"
},
"StopTimeout": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Stoptimeout"
},
"SystemControls": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/AwsSystemControl"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Systemcontrols"
},
"Ulimits": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/AwsUlimit"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Ulimits"
},
"User": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "User"
},
"VersionConsistency": {
"anyOf": [
{
"$ref": "#/$defs/AwsVersionConsistency"
},
{
"type": "null"
}
],
"default": null
},
"VolumesFrom": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/AwsVolumeFrom"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Volumesfrom"
},
"WorkingDirectory": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Workingdirectory"
}
},
"title": "AwsContainerDefinition",
"type": "object"
},
"AwsContainerDependency": {
"description": "AwsContainerDependency",
"properties": {
"Condition": {
"anyOf": [
{
"$ref": "#/$defs/AwsContainerCondition"
},
{
"type": "null"
}
],
"default": null
},
"ContainerName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Containername"
}
},
"title": "AwsContainerDependency",
"type": "object"
},
"AwsContainerRestartPolicy": {
"description": "AwsContainerRestartPolicy",
"properties": {
"Enabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Enabled"
},
"IgnoredExitCodes": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Ignoredexitcodes"
},
"RestartAttemptPeriod": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Restartattemptperiod"
}
},
"title": "AwsContainerRestartPolicy",
"type": "object"
},
"AwsDevice": {
"description": "AwsDevice",
"properties": {
"ContainerPath": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Containerpath"
},
"HostPath": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Hostpath"
},
"Permissions": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Permissions"
}
},
"title": "AwsDevice",
"type": "object"
},
"AwsDockerVolumeConfiguration": {
"description": "AwsDockerVolumeConfiguration",
"properties": {
"Autoprovision": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Autoprovision"
},
"Driver": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Driver"
},
"DriverOpts": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Driveropts"
},
"Labels": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Labels"
},
"Scope": {
"anyOf": [
{
"$ref": "#/$defs/AwsScope"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "AwsDockerVolumeConfiguration",
"type": "object"
},
"AwsEFSAuthorizationConfig": {
"description": "AwsEFSAuthorizationConfig",
"properties": {
"AccessPointId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Accesspointid"
},
"Iam": {
"anyOf": [
{
"$ref": "#/$defs/AwsEFSAuthorizationConfigIAM"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "AwsEFSAuthorizationConfig",
"type": "object"
},
"AwsEFSAuthorizationConfigIAM": {
"description": "AwsEFSAuthorizationConfigIAM",
"properties": {
"Value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
}
},
"title": "AwsEFSAuthorizationConfigIAM",
"type": "object"
},
"AwsEFSTransitEncryption": {
"description": "AwsEFSTransitEncryption",
"properties": {
"Value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
}
},
"title": "AwsEFSTransitEncryption",
"type": "object"
},
"AwsEFSVolumeConfiguration": {
"description": "AwsEFSVolumeConfiguration",
"properties": {
"AuthorizationConfig": {
"anyOf": [
{
"$ref": "#/$defs/AwsEFSAuthorizationConfig"
},
{
"type": "null"
}
],
"default": null
},
"FileSystemId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Filesystemid"
},
"RootDirectory": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Rootdirectory"
},
"TransitEncryption": {
"anyOf": [
{
"$ref": "#/$defs/AwsEFSTransitEncryption"
},
{
"type": "null"
}
],
"default": null
},
"TransitEncryptionPort": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Transitencryptionport"
}
},
"title": "AwsEFSVolumeConfiguration",
"type": "object"
},
"AwsEnvironmentFile": {
"description": "AwsEnvironmentFile",
"properties": {
"Type": {
"anyOf": [
{
"$ref": "#/$defs/AwsEnvironmentFileType"
},
{
"type": "null"
}
],
"default": null
},
"Value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
}
},
"title": "AwsEnvironmentFile",
"type": "object"
},
"AwsEnvironmentFileType": {
"description": "AwsEnvironmentFileType",
"properties": {
"Value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
}
},
"title": "AwsEnvironmentFileType",
"type": "object"
},
"AwsEphemeralStorage": {
"description": "AwsEphemeralStorage",
"properties": {
"SizeInGiB": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Sizeingib"
}
},
"title": "AwsEphemeralStorage",
"type": "object"
},
"AwsFSxWindowsFileServerAuthorizationConfig": {
"description": "AwsFSxWindowsFileServerAuthorizationConfig",
"properties": {
"CredentialsParameter": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Credentialsparameter"
},
"Domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Domain"
}
},
"title": "AwsFSxWindowsFileServerAuthorizationConfig",
"type": "object"
},
"AwsFSxWindowsFileServerVolumeConfiguration": {
"description": "AwsFSxWindowsFileServerVolumeConfiguration",
"properties": {
"AuthorizationConfig": {
"anyOf": [
{
"$ref": "#/$defs/AwsFSxWindowsFileServerAuthorizationConfig"
},
{
"type": "null"
}
],
"default": null
},
"FileSystemId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Filesystemid"
},
"RootDirectory": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Rootdirectory"
}
},
"title": "AwsFSxWindowsFileServerVolumeConfiguration",
"type": "object"
},
"AwsFirelensConfiguration": {
"description": "AwsFirelensConfiguration",
"properties": {
"Options": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Options"
},
"Type": {
"anyOf": [
{
"$ref": "#/$defs/AwsFirelensConfigurationType"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "AwsFirelensConfiguration",
"type": "object"
},
"AwsFirelensConfigurationType": {
"description": "AwsFirelensConfigurationType",
"properties": {
"Value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
}
},
"title": "AwsFirelensConfigurationType",
"type": "object"
},
"AwsHealthCheck": {
"description": "AwsHealthCheck",
"properties": {
"Command": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Command"
},
"Interval": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Interval"
},
"Retries": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Retries"
},
"StartPeriod": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Startperiod"
},
"Timeout": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Timeout"
}
},
"title": "AwsHealthCheck",
"type": "object"
},
"AwsHostEntry": {
"description": "AwsHostEntry",
"properties": {
"Hostname": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Hostname"
},
"IpAddress": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Ipaddress"
}
},
"title": "AwsHostEntry",
"type": "object"
},
"AwsHostVolumeProperties": {
"description": "AwsHostVolumeProperties",
"properties": {
"SourcePath": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Sourcepath"
}
},
"title": "AwsHostVolumeProperties",
"type": "object"
},
"AwsInferenceAccelerator": {
"description": "AwsInferenceAccelerator",
"properties": {
"DeviceName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Devicename"
},
"DeviceType": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Devicetype"
}
},
"title": "AwsInferenceAccelerator",
"type": "object"
},
"AwsIpcMode": {
"description": "AwsIpcMode",
"properties": {
"Value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
}
},
"title": "AwsIpcMode",
"type": "object"
},
"AwsKernelCapabilities": {
"description": "AwsKernelCapabilities",
"properties": {
"Add": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Add"
},
"Drop": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Drop"
}
},
"title": "AwsKernelCapabilities",
"type": "object"
},
"AwsKeyValuePair": {
"description": "AwsKeyValuePair",
"properties": {
"Name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"Value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
}
},
"title": "AwsKeyValuePair",
"type": "object"
},
"AwsLinuxParameters": {
"description": "AwsLinuxParameters",
"properties": {
"Capabilities": {
"anyOf": [
{
"$ref": "#/$defs/AwsKernelCapabilities"
},
{
"type": "null"
}
],
"default": null
},
"Devices": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/AwsDevice"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Devices"
},
"InitProcessEnabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Initprocessenabled"
},
"MaxSwap": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Maxswap"
},
"SharedMemorySize": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Sharedmemorysize"
},
"Swappiness": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Swappiness"
},
"Tmpfs": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/AwsTmpfs"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tmpfs"
}
},
"title": "AwsLinuxParameters",
"type": "object"
},
"AwsLogConfiguration": {
"description": "AwsLogConfiguration",
"properties": {
"LogDriver": {
"anyOf": [
{
"$ref": "#/$defs/AwsLogDriver"
},
{
"type": "null"
}
],
"default": null
},
"Options": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Options"
},
"SecretOptions": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/AwsSecret"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Secretoptions"
}
},
"title": "AwsLogConfiguration",
"type": "object"
},
"AwsLogDriver": {
"description": "AwsLogDriver",
"properties": {
"Value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
}
},
"title": "AwsLogDriver",
"type": "object"
},
"AwsMountPoint": {
"description": "AwsMountPoint",
"properties": {
"ContainerPath": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Containerpath"
},
"ReadOnly": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Readonly"
},
"SourceVolume": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Sourcevolume"
}
},
"title": "AwsMountPoint",
"type": "object"
},
"AwsNetworkMode": {
"description": "AwsNetworkMode",
"properties": {
"Value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
}
},
"title": "AwsNetworkMode",
"type": "object"
},
"AwsOSFamily": {
"description": "AwsOSFamily",
"properties": {
"Value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
}
},
"title": "AwsOSFamily",
"type": "object"
},
"AwsPidMode": {
"description": "AwsPidMode",
"properties": {
"Value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
}
},
"title": "AwsPidMode",
"type": "object"
},
"AwsPortMapping": {
"description": "AwsPortMapping",
"properties": {
"AppProtocol": {
"anyOf": [
{
"$ref": "#/$defs/AwsApplicationProtocol"
},
{
"type": "null"
}
],
"default": null
},
"ContainerPort": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Containerport"
},
"ContainerPortRange": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Containerportrange"
},
"HostPort": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Hostport"
},
"Name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"Protocol": {
"anyOf": [
{
"$ref": "#/$defs/AwsTransportProtocol"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "AwsPortMapping",
"type": "object"
},
"AwsProxyConfiguration": {
"description": "AwsProxyConfiguration",
"properties": {
"ContainerName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Containername"
},
"Properties": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/AwsKeyValuePair"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Properties"
},
"Type": {
"anyOf": [
{
"$ref": "#/$defs/AwsProxyConfigurationType"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "AwsProxyConfiguration",
"type": "object"
},
"AwsProxyConfigurationType": {
"description": "AwsProxyConfigurationType",
"properties": {
"Value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
}
},
"title": "AwsProxyConfigurationType",
"type": "object"
},
"AwsRepositoryCredentials": {
"description": "AwsRepositoryCredentials",
"properties": {
"CredentialsParameter": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Credentialsparameter"
}
},
"title": "AwsRepositoryCredentials",
"type": "object"
},
"AwsResourceRequirement": {
"description": "AwsResourceRequirement",
"properties": {
"Type": {
"anyOf": [
{
"$ref": "#/$defs/AwsResourceType"
},
{
"type": "null"
}
],
"default": null
},
"Value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
}
},
"title": "AwsResourceRequirement",
"type": "object"
},
"AwsResourceType": {
"description": "AwsResourceType",
"properties": {
"Value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
}
},
"title": "AwsResourceType",
"type": "object"
},
"AwsRuntimePlatform": {
"description": "AwsRuntimePlatform",
"properties": {
"CpuArchitecture": {
"anyOf": [
{
"$ref": "#/$defs/AwsCPUArchitecture"
},
{
"type": "null"
}
],
"default": null
},
"OperatingSystemFamily": {
"anyOf": [
{
"$ref": "#/$defs/AwsOSFamily"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "AwsRuntimePlatform",
"type": "object"
},
"AwsScope": {
"description": "AwsScope",
"properties": {
"Value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
}
},
"title": "AwsScope",
"type": "object"
},
"AwsSecret": {
"description": "AwsSecret",
"properties": {
"Name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"ValueFrom": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Valuefrom"
}
},
"title": "AwsSecret",
"type": "object"
},
"AwsSystemControl": {
"description": "AwsSystemControl",
"properties": {
"Namespace": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Namespace"
},
"Value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
}
},
"title": "AwsSystemControl",
"type": "object"
},
"AwsTag": {
"description": "AwsTag",
"properties": {
"Key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Key"
},
"Value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
}
},
"title": "AwsTag",
"type": "object"
},
"AwsTaskDefinitionPlacementConstraint": {
"description": "AwsTaskDefinitionPlacementConstraint",
"properties": {
"Expression": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Expression"
},
"Type": {
"anyOf": [
{
"$ref": "#/$defs/AwsTaskDefinitionPlacementConstraintType"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "AwsTaskDefinitionPlacementConstraint",
"type": "object"
},
"AwsTaskDefinitionPlacementConstraintType": {
"description": "AwsTaskDefinitionPlacementConstraintType",
"properties": {
"Value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
}
},
"title": "AwsTaskDefinitionPlacementConstraintType",
"type": "object"
},
"AwsTmpfs": {
"description": "AwsTmpfs",
"properties": {
"ContainerPath": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Containerpath"
},
"MountOptions": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Mountoptions"
},
"Size": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Size"
}
},
"title": "AwsTmpfs",
"type": "object"
},
"AwsTransportProtocol": {
"description": "AwsTransportProtocol",
"properties": {
"Value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
}
},
"title": "AwsTransportProtocol",
"type": "object"
},
"AwsUlimit": {
"description": "AwsUlimit",
"properties": {
"HardLimit": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Hardlimit"
},
"Name": {
"anyOf": [
{
"$ref": "#/$defs/AwsUlimitName"
},
{
"type": "null"
}
],
"default": null
},
"SoftLimit": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Softlimit"
}
},
"title": "AwsUlimit",
"type": "object"
},
"AwsUlimitName": {
"description": "AwsUlimitName",
"properties": {
"Value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
}
},
"title": "AwsUlimitName",
"type": "object"
},
"AwsVersionConsistency": {
"description": "AwsVersionConsistency",
"properties": {
"Value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
}
},
"title": "AwsVersionConsistency",
"type": "object"
},
"AwsVolume": {
"description": "AwsVolume",
"properties": {
"ConfiguredAtLaunch": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Configuredatlaunch"
},
"DockerVolumeConfiguration": {
"anyOf": [
{
"$ref": "#/$defs/AwsDockerVolumeConfiguration"
},
{
"type": "null"
}
],
"default": null
},
"EfsVolumeConfiguration": {
"anyOf": [
{
"$ref": "#/$defs/AwsEFSVolumeConfiguration"
},
{
"type": "null"
}
],
"default": null
},
"FsxWindowsFileServerVolumeConfiguration": {
"anyOf": [
{
"$ref": "#/$defs/AwsFSxWindowsFileServerVolumeConfiguration"
},
{
"type": "null"
}
],
"default": null
},
"Host": {
"anyOf": [
{
"$ref": "#/$defs/AwsHostVolumeProperties"
},
{
"type": "null"
}
],
"default": null
},
"Name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
}
},
"title": "AwsVolume",
"type": "object"
},
"AwsVolumeFrom": {
"description": "AwsVolumeFrom",
"properties": {
"ReadOnly": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Readonly"
},
"SourceContainer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Sourcecontainer"
}
},
"title": "AwsVolumeFrom",
"type": "object"
}
},
"description": "AwsRegisterTaskDefinitionRequest",
"properties": {
"ContainerDefinitions": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/AwsContainerDefinition"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Containerdefinitions"
},
"Cpu": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Cpu"
},
"EnableFaultInjection": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Enablefaultinjection"
},
"EphemeralStorage": {
"anyOf": [
{
"$ref": "#/$defs/AwsEphemeralStorage"
},
{
"type": "null"
}
],
"default": null
},
"ExecutionRoleArn": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Executionrolearn"
},
"Family": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Family"
},
"InferenceAccelerators": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/AwsInferenceAccelerator"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Inferenceaccelerators"
},
"IpcMode": {
"anyOf": [
{
"$ref": "#/$defs/AwsIpcMode"
},
{
"type": "null"
}
],
"default": null
},
"Memory": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Memory"
},
"NetworkMode": {
"anyOf": [
{
"$ref": "#/$defs/AwsNetworkMode"
},
{
"type": "null"
}
],
"default": null
},
"PidMode": {
"anyOf": [
{
"$ref": "#/$defs/AwsPidMode"
},
{
"type": "null"
}
],
"default": null
},
"PlacementConstraints": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/AwsTaskDefinitionPlacementConstraint"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Placementconstraints"
},
"ProxyConfiguration": {
"anyOf": [
{
"$ref": "#/$defs/AwsProxyConfiguration"
},
{
"type": "null"
}
],
"default": null
},
"RequiresCompatibilities": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Requirescompatibilities"
},
"RuntimePlatform": {
"anyOf": [
{
"$ref": "#/$defs/AwsRuntimePlatform"
},
{
"type": "null"
}
],
"default": null
},
"Tags": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/AwsTag"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"TaskRoleArn": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Taskrolearn"
},
"Volumes": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/AwsVolume"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Volumes"
}
},
"title": "AwsRegisterTaskDefinitionRequest",
"type": "object"
}Parameters:
--file, -f, --cli-input
A file to read the input from
Methods
list_detailed_services
List detailed ECS Services
Retrieve a list of all detailed ECS services in a tenant.
Returns:
| Name | Type | Description |
|---|---|---|
list |
list
|
A list of detailed ECS services in the tenant. |