libZSservicesZSamazonka-stepfunctionsZSamazonka-stepfunctions
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.StepFunctions.CreateActivity

Description

Creates an activity. An activity is a task that you write in any programming language and host on any machine that has access to AWS Step Functions. Activities must poll Step Functions using the GetActivityTask API action and respond using SendTask* API actions. This function lets Step Functions know the existence of your activity and returns an identifier for use in a state machine and when polling from the activity.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

CreateActivity is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateActivity's idempotency check is based on the activity name. If a following request has different tags values, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, tags will not be updated, even if they are different.

Synopsis

Creating a Request

data CreateActivity Source #

See: newCreateActivity smart constructor.

Constructors

CreateActivity' 

Fields

  • tags :: Maybe [Tag]

    The list of tags to add to a resource.

    An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.

    Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

  • name :: Text

    The name of the activity to create. This name must be unique for your AWS account and region for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.

    A name must not contain:

    • white space
    • brackets < > { } [ ]
    • wildcard characters ? *
    • special characters " # % \ ^ | ~ ` $ & , ; : /
    • control characters (U+0000-001F, U+007F-009F)

    To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

Instances

Instances details
Eq CreateActivity Source # 
Instance details

Defined in Amazonka.StepFunctions.CreateActivity

Read CreateActivity Source # 
Instance details

Defined in Amazonka.StepFunctions.CreateActivity

Show CreateActivity Source # 
Instance details

Defined in Amazonka.StepFunctions.CreateActivity

Generic CreateActivity Source # 
Instance details

Defined in Amazonka.StepFunctions.CreateActivity

Associated Types

type Rep CreateActivity :: Type -> Type #

NFData CreateActivity Source # 
Instance details

Defined in Amazonka.StepFunctions.CreateActivity

Methods

rnf :: CreateActivity -> () #

Hashable CreateActivity Source # 
Instance details

Defined in Amazonka.StepFunctions.CreateActivity

ToJSON CreateActivity Source # 
Instance details

Defined in Amazonka.StepFunctions.CreateActivity

AWSRequest CreateActivity Source # 
Instance details

Defined in Amazonka.StepFunctions.CreateActivity

Associated Types

type AWSResponse CreateActivity #

ToHeaders CreateActivity Source # 
Instance details

Defined in Amazonka.StepFunctions.CreateActivity

ToPath CreateActivity Source # 
Instance details

Defined in Amazonka.StepFunctions.CreateActivity

ToQuery CreateActivity Source # 
Instance details

Defined in Amazonka.StepFunctions.CreateActivity

type Rep CreateActivity Source # 
Instance details

Defined in Amazonka.StepFunctions.CreateActivity

type Rep CreateActivity = D1 ('MetaData "CreateActivity" "Amazonka.StepFunctions.CreateActivity" "libZSservicesZSamazonka-stepfunctionsZSamazonka-stepfunctions" 'False) (C1 ('MetaCons "CreateActivity'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse CreateActivity Source # 
Instance details

Defined in Amazonka.StepFunctions.CreateActivity

newCreateActivity Source #

Create a value of CreateActivity with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:tags:CreateActivity', createActivity_tags - The list of tags to add to a resource.

An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

$sel:name:CreateActivity', createActivity_name - The name of the activity to create. This name must be unique for your AWS account and region for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.

A name must not contain:

  • white space
  • brackets < > { } [ ]
  • wildcard characters ? *
  • special characters " # % \ ^ | ~ ` $ & , ; : /
  • control characters (U+0000-001F, U+007F-009F)

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

Request Lenses

createActivity_tags :: Lens' CreateActivity (Maybe [Tag]) Source #

The list of tags to add to a resource.

An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

createActivity_name :: Lens' CreateActivity Text Source #

The name of the activity to create. This name must be unique for your AWS account and region for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.

A name must not contain:

  • white space
  • brackets < > { } [ ]
  • wildcard characters ? *
  • special characters " # % \ ^ | ~ ` $ & , ; : /
  • control characters (U+0000-001F, U+007F-009F)

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

Destructuring the Response

data CreateActivityResponse Source #

See: newCreateActivityResponse smart constructor.

Constructors

CreateActivityResponse' 

Fields

Instances

Instances details
Eq CreateActivityResponse Source # 
Instance details

Defined in Amazonka.StepFunctions.CreateActivity

Read CreateActivityResponse Source # 
Instance details

Defined in Amazonka.StepFunctions.CreateActivity

Show CreateActivityResponse Source # 
Instance details

Defined in Amazonka.StepFunctions.CreateActivity

Generic CreateActivityResponse Source # 
Instance details

Defined in Amazonka.StepFunctions.CreateActivity

Associated Types

type Rep CreateActivityResponse :: Type -> Type #

NFData CreateActivityResponse Source # 
Instance details

Defined in Amazonka.StepFunctions.CreateActivity

Methods

rnf :: CreateActivityResponse -> () #

type Rep CreateActivityResponse Source # 
Instance details

Defined in Amazonka.StepFunctions.CreateActivity

type Rep CreateActivityResponse = D1 ('MetaData "CreateActivityResponse" "Amazonka.StepFunctions.CreateActivity" "libZSservicesZSamazonka-stepfunctionsZSamazonka-stepfunctions" 'False) (C1 ('MetaCons "CreateActivityResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "activityArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))))

newCreateActivityResponse Source #

Create a value of CreateActivityResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:CreateActivityResponse', createActivityResponse_httpStatus - The response's http status code.

$sel:activityArn:CreateActivityResponse', createActivityResponse_activityArn - The Amazon Resource Name (ARN) that identifies the created activity.

$sel:creationDate:CreateActivityResponse', createActivityResponse_creationDate - The date the activity is created.

Response Lenses

createActivityResponse_activityArn :: Lens' CreateActivityResponse Text Source #

The Amazon Resource Name (ARN) that identifies the created activity.