Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SSMSAP.RegisterApplication

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Register an SAP application with AWS Systems Manager for SAP. You must meet the following requirements before registering.

The SAP application you want to register with AWS Systems Manager for SAP is running on Amazon EC2.

AWS Systems Manager Agent must be setup on an Amazon EC2 instance along with the required IAM permissions.

Amazon EC2 instance(s) must have access to the secrets created in AWS Secrets Manager to manage SAP applications and components.

Synopsis

data RegisterApplication = RegisterApplication' {
- sapInstanceNumber :: Maybe Text
- sid :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- applicationId :: Text
- applicationType :: ApplicationType
- instances :: NonEmpty Text
- credentials :: NonEmpty ApplicationCredential
}
newRegisterApplication :: Text -> ApplicationType -> NonEmpty Text -> NonEmpty ApplicationCredential -> RegisterApplication
registerApplication_sapInstanceNumber :: Lens' RegisterApplication (Maybe Text)
registerApplication_sid :: Lens' RegisterApplication (Maybe Text)
registerApplication_tags :: Lens' RegisterApplication (Maybe (HashMap Text Text))
registerApplication_applicationId :: Lens' RegisterApplication Text
registerApplication_applicationType :: Lens' RegisterApplication ApplicationType
registerApplication_instances :: Lens' RegisterApplication (NonEmpty Text)
registerApplication_credentials :: Lens' RegisterApplication (NonEmpty ApplicationCredential)
data RegisterApplicationResponse = RegisterApplicationResponse' {
- application :: Maybe Application
- operationId :: Maybe Text
- httpStatus :: Int
}
newRegisterApplicationResponse :: Int -> RegisterApplicationResponse
registerApplicationResponse_application :: Lens' RegisterApplicationResponse (Maybe Application)
registerApplicationResponse_operationId :: Lens' RegisterApplicationResponse (Maybe Text)
registerApplicationResponse_httpStatus :: Lens' RegisterApplicationResponse Int

Creating a Request

data RegisterApplication Source #

See: newRegisterApplication smart constructor.

Constructors

RegisterApplication'
Fields sapInstanceNumber :: Maybe Text sid :: Maybe Text tags :: Maybe (HashMap Text Text) applicationId :: Text applicationType :: ApplicationType instances :: NonEmpty Text credentials :: NonEmpty ApplicationCredential

Instances

Instances details

ToJSON RegisterApplication Source #
Instance details Defined in Amazonka.SSMSAP.RegisterApplication Methods toJSON :: RegisterApplication -> Value # toEncoding :: RegisterApplication -> Encoding # toJSONList :: [RegisterApplication] -> Value # toEncodingList :: [RegisterApplication] -> Encoding #
ToHeaders RegisterApplication Source #
Instance details Defined in Amazonka.SSMSAP.RegisterApplication Methods toHeaders :: RegisterApplication -> [Header] #
ToPath RegisterApplication Source #
Instance details Defined in Amazonka.SSMSAP.RegisterApplication Methods toPath :: RegisterApplication -> ByteString #
ToQuery RegisterApplication Source #
Instance details Defined in Amazonka.SSMSAP.RegisterApplication Methods toQuery :: RegisterApplication -> QueryString #
AWSRequest RegisterApplication Source #
Instance details Defined in Amazonka.SSMSAP.RegisterApplication Associated Types type AWSResponse RegisterApplication # Methods request :: (Service -> Service) -> RegisterApplication -> Request RegisterApplication # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy RegisterApplication -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RegisterApplication))) #
Generic RegisterApplication Source #
Instance details Defined in Amazonka.SSMSAP.RegisterApplication Associated Types type Rep RegisterApplication :: Type -> Type # Methods from :: RegisterApplication -> Rep RegisterApplication x # to :: Rep RegisterApplication x -> RegisterApplication #
Show RegisterApplication Source #
Instance details Defined in Amazonka.SSMSAP.RegisterApplication Methods showsPrec :: Int -> RegisterApplication -> ShowS # show :: RegisterApplication -> String # showList :: [RegisterApplication] -> ShowS #
NFData RegisterApplication Source #
Instance details Defined in Amazonka.SSMSAP.RegisterApplication Methods rnf :: RegisterApplication -> () #
Eq RegisterApplication Source #
Instance details Defined in Amazonka.SSMSAP.RegisterApplication Methods (==) :: RegisterApplication -> RegisterApplication -> Bool # (/=) :: RegisterApplication -> RegisterApplication -> Bool #
Hashable RegisterApplication Source #
Instance details Defined in Amazonka.SSMSAP.RegisterApplication Methods hashWithSalt :: Int -> RegisterApplication -> Int # hash :: RegisterApplication -> Int #
type AWSResponse RegisterApplication Source #
Instance details Defined in Amazonka.SSMSAP.RegisterApplication type AWSResponse RegisterApplication = RegisterApplicationResponse
type Rep RegisterApplication Source #
Instance details Defined in Amazonka.SSMSAP.RegisterApplication type Rep RegisterApplication = D1 ('MetaData "RegisterApplication" "Amazonka.SSMSAP.RegisterApplication" "amazonka-ssm-sap-2.0-7GrfuL8AFBH3uo82BcKo6b" 'False) (C1 ('MetaCons "RegisterApplication'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sapInstanceNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "sid") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :: ((S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "applicationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ApplicationType)) :: (S1 ('MetaSel ('Just "instances") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)) :: S1 ('MetaSel ('Just "credentials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty ApplicationCredential))))))

newRegisterApplication Source #

Arguments

:: Text	`RegisterApplication`
-> ApplicationType	`$sel:applicationType:RegisterApplication'`
-> NonEmpty Text	`$sel:instances:RegisterApplication'`
-> NonEmpty ApplicationCredential	`RegisterApplication`
-> RegisterApplication

Create a value of RegisterApplication 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:sapInstanceNumber:RegisterApplication', registerApplication_sapInstanceNumber -

$sel:sid:RegisterApplication', registerApplication_sid -

RegisterApplication, registerApplication_tags -

RegisterApplication, registerApplication_applicationId -

$sel:applicationType:RegisterApplication', registerApplication_applicationType -

$sel:instances:RegisterApplication', registerApplication_instances -

RegisterApplication, registerApplication_credentials -

Request Lenses

registerApplication_sapInstanceNumber :: Lens' RegisterApplication (Maybe Text) Source #

registerApplication_sid :: Lens' RegisterApplication (Maybe Text) Source #

registerApplication_tags :: Lens' RegisterApplication (Maybe (HashMap Text Text)) Source #

registerApplication_applicationId :: Lens' RegisterApplication Text Source #

registerApplication_applicationType :: Lens' RegisterApplication ApplicationType Source #

registerApplication_instances :: Lens' RegisterApplication (NonEmpty Text) Source #

registerApplication_credentials :: Lens' RegisterApplication (NonEmpty ApplicationCredential) Source #

Destructuring the Response

data RegisterApplicationResponse Source #

See: newRegisterApplicationResponse smart constructor.

Constructors

RegisterApplicationResponse'
Fields application :: Maybe Application operationId :: Maybe Text httpStatus :: Int The response's http status code.

Instances

Instances details

Generic RegisterApplicationResponse Source #
Instance details Defined in Amazonka.SSMSAP.RegisterApplication Associated Types type Rep RegisterApplicationResponse :: Type -> Type # Methods from :: RegisterApplicationResponse -> Rep RegisterApplicationResponse x # to :: Rep RegisterApplicationResponse x -> RegisterApplicationResponse #
Read RegisterApplicationResponse Source #
Instance details Defined in Amazonka.SSMSAP.RegisterApplication Methods readsPrec :: Int -> ReadS RegisterApplicationResponse # readList :: ReadS [RegisterApplicationResponse] # readPrec :: ReadPrec RegisterApplicationResponse # readListPrec :: ReadPrec [RegisterApplicationResponse] #
Show RegisterApplicationResponse Source #
Instance details Defined in Amazonka.SSMSAP.RegisterApplication Methods showsPrec :: Int -> RegisterApplicationResponse -> ShowS # show :: RegisterApplicationResponse -> String # showList :: [RegisterApplicationResponse] -> ShowS #
NFData RegisterApplicationResponse Source #
Instance details Defined in Amazonka.SSMSAP.RegisterApplication Methods rnf :: RegisterApplicationResponse -> () #
Eq RegisterApplicationResponse Source #
Instance details Defined in Amazonka.SSMSAP.RegisterApplication Methods (==) :: RegisterApplicationResponse -> RegisterApplicationResponse -> Bool # (/=) :: RegisterApplicationResponse -> RegisterApplicationResponse -> Bool #
type Rep RegisterApplicationResponse Source #
Instance details Defined in Amazonka.SSMSAP.RegisterApplication type Rep RegisterApplicationResponse = D1 ('MetaData "RegisterApplicationResponse" "Amazonka.SSMSAP.RegisterApplication" "amazonka-ssm-sap-2.0-7GrfuL8AFBH3uo82BcKo6b" 'False) (C1 ('MetaCons "RegisterApplicationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "application") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Application)) :: (S1 ('MetaSel ('Just "operationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newRegisterApplicationResponse Source #

Arguments

:: Int	`$sel:httpStatus:RegisterApplicationResponse'`
-> RegisterApplicationResponse

Create a value of RegisterApplicationResponse 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:application:RegisterApplicationResponse', registerApplicationResponse_application -

$sel:operationId:RegisterApplicationResponse', registerApplicationResponse_operationId -

$sel:httpStatus:RegisterApplicationResponse', registerApplicationResponse_httpStatus - The response's http status code.

Response Lenses

registerApplicationResponse_application :: Lens' RegisterApplicationResponse (Maybe Application) Source #

registerApplicationResponse_operationId :: Lens' RegisterApplicationResponse (Maybe Text) Source #

registerApplicationResponse_httpStatus :: Lens' RegisterApplicationResponse Int Source #

The response's http status code.