IAmazonBatch.RegisterJobDefinition Method (RegisterJobDefinitionRequest)

Registers an Batch job definition.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to RegisterJobDefinitionAsync.

Namespace: Amazon.Batch
Assembly: AWSSDK.Batch.dll
Version: 3.x.y.z

Syntax

public abstract RegisterJobDefinitionResponse RegisterJobDefinition(
         RegisterJobDefinitionRequest request
)

Parameters

request: Type: Amazon.Batch.Model.RegisterJobDefinitionRequest

Container for the necessary parameters to execute the RegisterJobDefinition service method.

Return Value

Type: RegisterJobDefinitionResponse

The response from the RegisterJobDefinition service method, as returned by Batch.

Exceptions

Exception	Condition
ClientException	These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.
ServerException	These errors are usually caused by a server issue.

Examples

This example registers a job definition for a simple container job.

To register a job definition


var client = new AmazonBatchClient();
var response = client.RegisterJobDefinition(new RegisterJobDefinitionRequest 
{
    Type = "container",
    ContainerProperties = new ContainerProperties {
        Command = new List<string> {
            "sleep",
            "10"
        },
        Image = "busybox",
        ResourceRequirements = new List<ResourceRequirement> {
            new ResourceRequirement {
                Type = "MEMORY",
                Value = "128"
            },
            new ResourceRequirement {
                Type = "VCPU",
                Value = "1"
            }
        }
    },
    JobDefinitionName = "sleep10"
});

string jobDefinitionArn = response.JobDefinitionArn;
string jobDefinitionName = response.JobDefinitionName;
int revision = response.Revision;

This demonstrates calling the RegisterJobDefinition action, including tags.

RegisterJobDefinition with tags


var client = new AmazonBatchClient();
var response = client.RegisterJobDefinition(new RegisterJobDefinitionRequest 
{
    Type = "container",
    ContainerProperties = new ContainerProperties {
        Command = new List<string> {
            "sleep",
            "30"
        },
        Image = "busybox",
        ResourceRequirements = new List<ResourceRequirement> {
            new ResourceRequirement {
                Type = "MEMORY",
                Value = "128"
            },
            new ResourceRequirement {
                Type = "VCPU",
                Value = "1"
            }
        }
    },
    JobDefinitionName = "sleep30",
    Tags = new Dictionary<string, string> {
        { "Department", "Engineering" },
        { "User", "JaneDoe" }
    }
});

string jobDefinitionArn = response.JobDefinitionArn;
string jobDefinitionName = response.JobDefinitionName;
int revision = response.Revision;

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

IAmazonBatch.RegisterJobDefinition (RegisterJobDefinitionRequest)

Method