1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package swf
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/swf/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Registers a new activity type along with its configuration settings in the
// specified domain.
//
// A TypeAlreadyExists fault is returned if the type already exists in the domain.
// You cannot change any configuration settings of the type after its registration,
// and it must be registered as a new version.
//
// # Access Control
//
// You can use IAM policies to control this action's access to Amazon SWF
// resources as follows:
//
// - Use a Resource element with the domain name to limit the action to only
// specified domains.
//
// - Use an Action element to allow or deny permission to call this action.
//
// - Constrain the following parameters by using a Condition element with the
// appropriate keys.
//
// - defaultTaskList.name : String constraint. The key is
// swf:defaultTaskList.name .
//
// - name : String constraint. The key is swf:name .
//
// - version : String constraint. The key is swf:version .
//
// If the caller doesn't have sufficient permissions to invoke the action, or the
// parameter values fall outside the specified constraints, the action fails. The
// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED .
// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide.
//
// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
func (c *Client) RegisterActivityType(ctx context.Context, params *RegisterActivityTypeInput, optFns ...func(*Options)) (*RegisterActivityTypeOutput, error) {
if params == nil {
params = &RegisterActivityTypeInput{}
}
result, metadata, err := c.invokeOperation(ctx, "RegisterActivityType", params, optFns, c.addOperationRegisterActivityTypeMiddlewares)
if err != nil {
return nil, err
}
out := result.(*RegisterActivityTypeOutput)
out.ResultMetadata = metadata
return out, nil
}
type RegisterActivityTypeInput struct {
// The name of the domain in which this activity is to be registered.
//
// This member is required.
Domain *string
// The name of the activity type within the domain.
//
// The specified string must not contain a : (colon), / (slash), | (vertical bar),
// or any control characters ( \u0000-\u001f | \u007f-\u009f ). Also, it must not
// be the literal string arn .
//
// This member is required.
Name *string
// The version of the activity type.
//
// The activity type consists of the name and version, the combination of which
// must be unique within the domain.
//
// The specified string must not contain a : (colon), / (slash), | (vertical bar),
// or any control characters ( \u0000-\u001f | \u007f-\u009f ). Also, it must not
// be the literal string arn .
//
// This member is required.
Version *string
// If set, specifies the default maximum time before which a worker processing a
// task of this type must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded,
// the activity task is automatically timed out. This default can be overridden
// when scheduling an activity task using the ScheduleActivityTaskDecision . If the
// activity worker subsequently attempts to record a heartbeat or returns a result,
// the activity worker receives an UnknownResource fault. In this case, Amazon SWF
// no longer considers the activity task to be valid; the activity worker should
// clean up the activity task.
//
// The duration is specified in seconds, an integer greater than or equal to 0 .
// You can use NONE to specify unlimited duration.
DefaultTaskHeartbeatTimeout *string
// If set, specifies the default task list to use for scheduling tasks of this
// activity type. This default task list is used if a task list isn't provided when
// a task is scheduled through the ScheduleActivityTaskDecision .
DefaultTaskList *types.TaskList
// The default task priority to assign to the activity type. If not assigned, then
// 0 is used. Valid values are integers that range from Java's Integer.MIN_VALUE
// (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher
// priority.
//
// For more information about setting task priority, see [Setting Task Priority] in the in the Amazon SWF
// Developer Guide..
//
// [Setting Task Priority]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html
DefaultTaskPriority *string
// If set, specifies the default maximum duration for a task of this activity
// type. This default can be overridden when scheduling an activity task using the
// ScheduleActivityTaskDecision .
//
// The duration is specified in seconds, an integer greater than or equal to 0 .
// You can use NONE to specify unlimited duration.
DefaultTaskScheduleToCloseTimeout *string
// If set, specifies the default maximum duration that a task of this activity
// type can wait before being assigned to a worker. This default can be overridden
// when scheduling an activity task using the ScheduleActivityTaskDecision .
//
// The duration is specified in seconds, an integer greater than or equal to 0 .
// You can use NONE to specify unlimited duration.
DefaultTaskScheduleToStartTimeout *string
// If set, specifies the default maximum duration that a worker can take to
// process tasks of this activity type. This default can be overridden when
// scheduling an activity task using the ScheduleActivityTaskDecision .
//
// The duration is specified in seconds, an integer greater than or equal to 0 .
// You can use NONE to specify unlimited duration.
DefaultTaskStartToCloseTimeout *string
// A textual description of the activity type.
Description *string
noSmithyDocumentSerde
}
type RegisterActivityTypeOutput struct {
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationRegisterActivityTypeMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson10_serializeOpRegisterActivityType{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson10_deserializeOpRegisterActivityType{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "RegisterActivityType"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = addRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addTimeOffsetBuild(stack, c); err != nil {
return err
}
if err = addUserAgentRetryMode(stack, options); err != nil {
return err
}
if err = addOpRegisterActivityTypeValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opRegisterActivityType(options.Region), middleware.Before); err != nil {
return err
}
if err = addRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opRegisterActivityType(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "RegisterActivityType",
}
}
|