ServiceCatalog / Client / create_service_action

create_service_action#

ServiceCatalog.Client.create_service_action(**kwargs)#

Creates a self-service action.

See also: AWS API Documentation

Request Syntax

response = client.create_service_action(
    Name='string',
    DefinitionType='SSM_AUTOMATION',
    Definition={
        'string': 'string'
    },
    Description='string',
    AcceptLanguage='string',
    IdempotencyToken='string'
)
Parameters:

  • Name (string) –

    [REQUIRED]

    The self-service action name.

  • DefinitionType (string) –

    [REQUIRED]

    The service action definition type. For example, SSM_AUTOMATION.

  • Definition (dict) –

    [REQUIRED]

    The self-service action definition. Can be one of the following:

    Name

    The name of the Amazon Web Services Systems Manager document (SSM document). For example, AWS-RestartEC2Instance.

    If you are using a shared SSM document, you must provide the ARN instead of the name.

    Version

    The Amazon Web Services Systems Manager automation document version. For example, "Version": "1"

    AssumeRole

    The Amazon Resource Name (ARN) of the role that performs the self-service actions on your behalf. For example, "AssumeRole": "arn:aws:iam::12345678910:role/ActionRole".

    To reuse the provisioned product launch role, set to "AssumeRole": "LAUNCH_ROLE".

    Parameters

    The list of parameters in JSON format.

    For example: [{\"Name\":\"InstanceId\",\"Type\":\"TARGET\"}] or [{\"Name\":\"InstanceId\",\"Type\":\"TEXT_VALUE\"}].

    • (string) –

      • (string) –

  • Description (string) – The self-service action description.

  • AcceptLanguage (string) –

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • IdempotencyToken (string) –

    [REQUIRED]

    A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'ServiceActionDetail': {
        'ServiceActionSummary': {
            'Id': 'string',
            'Name': 'string',
            'Description': 'string',
            'DefinitionType': 'SSM_AUTOMATION'
        },
        'Definition': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • ServiceActionDetail (dict) –

      An object containing information about the self-service action.

      • ServiceActionSummary (dict) –

        Summary information about the self-service action.

        • Id (string) –

          The self-service action identifier.

        • Name (string) –

          The self-service action name.

        • Description (string) –

          The self-service action description.

        • DefinitionType (string) –

          The self-service action definition type. For example, SSM_AUTOMATION.

      • Definition (dict) –

        A map that defines the self-service action.

        • (string) –

          • (string) –

Exceptions

  • ServiceCatalog.Client.exceptions.InvalidParametersException

  • ServiceCatalog.Client.exceptions.LimitExceededException