libZSservicesZSamazonka-servicecatalogZSamazonka-servicecatalog
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.ServiceCatalog.CreateServiceAction

Description

Creates a self-service action.

Synopsis

Creating a Request

data CreateServiceAction Source #

See: newCreateServiceAction smart constructor.

Constructors

CreateServiceAction' 

Fields

  • acceptLanguage :: Maybe Text

    The language code.

    • en - English (default)
    • jp - Japanese
    • zh - Chinese
  • description :: Maybe Text

    The self-service action description.

  • name :: Text

    The self-service action name.

  • definitionType :: ServiceActionDefinitionType

    The service action definition type. For example, SSM_AUTOMATION.

  • definition :: HashMap ServiceActionDefinitionKey Text

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

    Name
    The name of the AWS 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 AWS 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\"}].

  • idempotencyToken :: Text

    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.

Instances

Instances details
Eq CreateServiceAction Source # 
Instance details

Defined in Amazonka.ServiceCatalog.CreateServiceAction

Read CreateServiceAction Source # 
Instance details

Defined in Amazonka.ServiceCatalog.CreateServiceAction

Show CreateServiceAction Source # 
Instance details

Defined in Amazonka.ServiceCatalog.CreateServiceAction

Generic CreateServiceAction Source # 
Instance details

Defined in Amazonka.ServiceCatalog.CreateServiceAction

Associated Types

type Rep CreateServiceAction :: Type -> Type #

NFData CreateServiceAction Source # 
Instance details

Defined in Amazonka.ServiceCatalog.CreateServiceAction

Methods

rnf :: CreateServiceAction -> () #

Hashable CreateServiceAction Source # 
Instance details

Defined in Amazonka.ServiceCatalog.CreateServiceAction

ToJSON CreateServiceAction Source # 
Instance details

Defined in Amazonka.ServiceCatalog.CreateServiceAction

AWSRequest CreateServiceAction Source # 
Instance details

Defined in Amazonka.ServiceCatalog.CreateServiceAction

Associated Types

type AWSResponse CreateServiceAction #

ToHeaders CreateServiceAction Source # 
Instance details

Defined in Amazonka.ServiceCatalog.CreateServiceAction

ToPath CreateServiceAction Source # 
Instance details

Defined in Amazonka.ServiceCatalog.CreateServiceAction

ToQuery CreateServiceAction Source # 
Instance details

Defined in Amazonka.ServiceCatalog.CreateServiceAction

type Rep CreateServiceAction Source # 
Instance details

Defined in Amazonka.ServiceCatalog.CreateServiceAction

type Rep CreateServiceAction = D1 ('MetaData "CreateServiceAction" "Amazonka.ServiceCatalog.CreateServiceAction" "libZSservicesZSamazonka-servicecatalogZSamazonka-servicecatalog" 'False) (C1 ('MetaCons "CreateServiceAction'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "acceptLanguage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "definitionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ServiceActionDefinitionType) :*: (S1 ('MetaSel ('Just "definition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap ServiceActionDefinitionKey Text)) :*: S1 ('MetaSel ('Just "idempotencyToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse CreateServiceAction Source # 
Instance details

Defined in Amazonka.ServiceCatalog.CreateServiceAction

newCreateServiceAction Source #

Create a value of CreateServiceAction 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:acceptLanguage:CreateServiceAction', createServiceAction_acceptLanguage - The language code.

  • en - English (default)
  • jp - Japanese
  • zh - Chinese

$sel:description:CreateServiceAction', createServiceAction_description - The self-service action description.

$sel:name:CreateServiceAction', createServiceAction_name - The self-service action name.

$sel:definitionType:CreateServiceAction', createServiceAction_definitionType - The service action definition type. For example, SSM_AUTOMATION.

$sel:definition:CreateServiceAction', createServiceAction_definition - The self-service action definition. Can be one of the following:

Name
The name of the AWS 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 AWS 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\"}].

$sel:idempotencyToken:CreateServiceAction', createServiceAction_idempotencyToken - 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.

Request Lenses

createServiceAction_acceptLanguage :: Lens' CreateServiceAction (Maybe Text) Source #

The language code.

  • en - English (default)
  • jp - Japanese
  • zh - Chinese

createServiceAction_definitionType :: Lens' CreateServiceAction ServiceActionDefinitionType Source #

The service action definition type. For example, SSM_AUTOMATION.

createServiceAction_definition :: Lens' CreateServiceAction (HashMap ServiceActionDefinitionKey Text) Source #

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

Name
The name of the AWS 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 AWS 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\"}].

createServiceAction_idempotencyToken :: Lens' CreateServiceAction Text Source #

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.

Destructuring the Response

data CreateServiceActionResponse Source #

See: newCreateServiceActionResponse smart constructor.

Constructors

CreateServiceActionResponse' 

Fields

Instances

Instances details
Eq CreateServiceActionResponse Source # 
Instance details

Defined in Amazonka.ServiceCatalog.CreateServiceAction

Read CreateServiceActionResponse Source # 
Instance details

Defined in Amazonka.ServiceCatalog.CreateServiceAction

Show CreateServiceActionResponse Source # 
Instance details

Defined in Amazonka.ServiceCatalog.CreateServiceAction

Generic CreateServiceActionResponse Source # 
Instance details

Defined in Amazonka.ServiceCatalog.CreateServiceAction

Associated Types

type Rep CreateServiceActionResponse :: Type -> Type #

NFData CreateServiceActionResponse Source # 
Instance details

Defined in Amazonka.ServiceCatalog.CreateServiceAction

type Rep CreateServiceActionResponse Source # 
Instance details

Defined in Amazonka.ServiceCatalog.CreateServiceAction

type Rep CreateServiceActionResponse = D1 ('MetaData "CreateServiceActionResponse" "Amazonka.ServiceCatalog.CreateServiceAction" "libZSservicesZSamazonka-servicecatalogZSamazonka-servicecatalog" 'False) (C1 ('MetaCons "CreateServiceActionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serviceActionDetail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceActionDetail)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateServiceActionResponse Source #

Create a value of CreateServiceActionResponse 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:serviceActionDetail:CreateServiceActionResponse', createServiceActionResponse_serviceActionDetail - An object containing information about the self-service action.

$sel:httpStatus:CreateServiceActionResponse', createServiceActionResponse_httpStatus - The response's http status code.

Response Lenses

createServiceActionResponse_serviceActionDetail :: Lens' CreateServiceActionResponse (Maybe ServiceActionDetail) Source #

An object containing information about the self-service action.