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.PrivateNetworks.ConfigureAccessPoint

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Configures the specified network resource.

Use this action to specify the geographic position of the hardware. You must provide Certified Professional Installer (CPI) credentials in the request so that we can obtain spectrum grants. For more information, see Radio units in the Amazon Web Services Private 5G User Guide.

Synopsis

data ConfigureAccessPoint = ConfigureAccessPoint' {
- cpiSecretKey :: Maybe (Sensitive Text)
- cpiUserId :: Maybe (Sensitive Text)
- cpiUserPassword :: Maybe (Sensitive Text)
- cpiUsername :: Maybe (Sensitive Text)
- position :: Maybe Position
- accessPointArn :: Text
}
newConfigureAccessPoint :: Text -> ConfigureAccessPoint
configureAccessPoint_cpiSecretKey :: Lens' ConfigureAccessPoint (Maybe Text)
configureAccessPoint_cpiUserId :: Lens' ConfigureAccessPoint (Maybe Text)
configureAccessPoint_cpiUserPassword :: Lens' ConfigureAccessPoint (Maybe Text)
configureAccessPoint_cpiUsername :: Lens' ConfigureAccessPoint (Maybe Text)
configureAccessPoint_position :: Lens' ConfigureAccessPoint (Maybe Position)
configureAccessPoint_accessPointArn :: Lens' ConfigureAccessPoint Text
data ConfigureAccessPointResponse = ConfigureAccessPointResponse' {
- httpStatus :: Int
- accessPoint :: NetworkResource
}
newConfigureAccessPointResponse :: Int -> NetworkResource -> ConfigureAccessPointResponse
configureAccessPointResponse_httpStatus :: Lens' ConfigureAccessPointResponse Int
configureAccessPointResponse_accessPoint :: Lens' ConfigureAccessPointResponse NetworkResource

Creating a Request

data ConfigureAccessPoint Source #

See: newConfigureAccessPoint smart constructor.

Constructors

ConfigureAccessPoint'

Fields

cpiSecretKey :: Maybe (Sensitive Text)
A Base64 encoded string of the CPI certificate associated with the CPI user who is certifying the coordinates of the network resource.
cpiUserId :: Maybe (Sensitive Text)
The CPI user ID of the CPI user who is certifying the coordinates of the network resource.
cpiUserPassword :: Maybe (Sensitive Text)
The CPI password associated with the CPI certificate in cpiSecretKey.
cpiUsername :: Maybe (Sensitive Text)
The CPI user name of the CPI user who is certifying the coordinates of the radio unit.
position :: Maybe Position
The position of the network resource.
accessPointArn :: Text
The Amazon Resource Name (ARN) of the network resource.

Instances

Instances details

ToJSON ConfigureAccessPoint Source #
Instance details Defined in Amazonka.PrivateNetworks.ConfigureAccessPoint Methods toJSON :: ConfigureAccessPoint -> Value # toEncoding :: ConfigureAccessPoint -> Encoding # toJSONList :: [ConfigureAccessPoint] -> Value # toEncodingList :: [ConfigureAccessPoint] -> Encoding #
ToHeaders ConfigureAccessPoint Source #
Instance details Defined in Amazonka.PrivateNetworks.ConfigureAccessPoint Methods toHeaders :: ConfigureAccessPoint -> [Header] #
ToPath ConfigureAccessPoint Source #
Instance details Defined in Amazonka.PrivateNetworks.ConfigureAccessPoint Methods toPath :: ConfigureAccessPoint -> ByteString #
ToQuery ConfigureAccessPoint Source #
Instance details Defined in Amazonka.PrivateNetworks.ConfigureAccessPoint Methods toQuery :: ConfigureAccessPoint -> QueryString #
AWSRequest ConfigureAccessPoint Source #
Instance details Defined in Amazonka.PrivateNetworks.ConfigureAccessPoint Associated Types type AWSResponse ConfigureAccessPoint # Methods request :: (Service -> Service) -> ConfigureAccessPoint -> Request ConfigureAccessPoint # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ConfigureAccessPoint -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ConfigureAccessPoint))) #
Generic ConfigureAccessPoint Source #
Instance details Defined in Amazonka.PrivateNetworks.ConfigureAccessPoint Associated Types type Rep ConfigureAccessPoint :: Type -> Type # Methods from :: ConfigureAccessPoint -> Rep ConfigureAccessPoint x # to :: Rep ConfigureAccessPoint x -> ConfigureAccessPoint #
Show ConfigureAccessPoint Source #
Instance details Defined in Amazonka.PrivateNetworks.ConfigureAccessPoint Methods showsPrec :: Int -> ConfigureAccessPoint -> ShowS # show :: ConfigureAccessPoint -> String # showList :: [ConfigureAccessPoint] -> ShowS #
NFData ConfigureAccessPoint Source #
Instance details Defined in Amazonka.PrivateNetworks.ConfigureAccessPoint Methods rnf :: ConfigureAccessPoint -> () #
Eq ConfigureAccessPoint Source #
Instance details Defined in Amazonka.PrivateNetworks.ConfigureAccessPoint Methods (==) :: ConfigureAccessPoint -> ConfigureAccessPoint -> Bool # (/=) :: ConfigureAccessPoint -> ConfigureAccessPoint -> Bool #
Hashable ConfigureAccessPoint Source #
Instance details Defined in Amazonka.PrivateNetworks.ConfigureAccessPoint Methods hashWithSalt :: Int -> ConfigureAccessPoint -> Int # hash :: ConfigureAccessPoint -> Int #
type AWSResponse ConfigureAccessPoint Source #
Instance details Defined in Amazonka.PrivateNetworks.ConfigureAccessPoint type AWSResponse ConfigureAccessPoint = ConfigureAccessPointResponse
type Rep ConfigureAccessPoint Source #
Instance details Defined in Amazonka.PrivateNetworks.ConfigureAccessPoint type Rep ConfigureAccessPoint = D1 ('MetaData "ConfigureAccessPoint" "Amazonka.PrivateNetworks.ConfigureAccessPoint" "amazonka-privatenetworks-2.0-6kTUHQMy1b1JCa08Y5Egzo" 'False) (C1 ('MetaCons "ConfigureAccessPoint'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cpiSecretKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: (S1 ('MetaSel ('Just "cpiUserId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "cpiUserPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) :: (S1 ('MetaSel ('Just "cpiUsername") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Position)) :*: S1 ('MetaSel ('Just "accessPointArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newConfigureAccessPoint Source #

Arguments

:: Text	`$sel:accessPointArn:ConfigureAccessPoint'`
-> ConfigureAccessPoint

Create a value of ConfigureAccessPoint 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:cpiSecretKey:ConfigureAccessPoint', configureAccessPoint_cpiSecretKey - A Base64 encoded string of the CPI certificate associated with the CPI user who is certifying the coordinates of the network resource.

$sel:cpiUserId:ConfigureAccessPoint', configureAccessPoint_cpiUserId - The CPI user ID of the CPI user who is certifying the coordinates of the network resource.

$sel:cpiUserPassword:ConfigureAccessPoint', configureAccessPoint_cpiUserPassword - The CPI password associated with the CPI certificate in cpiSecretKey.

$sel:cpiUsername:ConfigureAccessPoint', configureAccessPoint_cpiUsername - The CPI user name of the CPI user who is certifying the coordinates of the radio unit.

ConfigureAccessPoint, configureAccessPoint_position - The position of the network resource.

$sel:accessPointArn:ConfigureAccessPoint', configureAccessPoint_accessPointArn - The Amazon Resource Name (ARN) of the network resource.

Request Lenses

configureAccessPoint_cpiSecretKey :: Lens' ConfigureAccessPoint (Maybe Text) Source #

A Base64 encoded string of the CPI certificate associated with the CPI user who is certifying the coordinates of the network resource.

configureAccessPoint_cpiUserId :: Lens' ConfigureAccessPoint (Maybe Text) Source #

The CPI user ID of the CPI user who is certifying the coordinates of the network resource.

configureAccessPoint_cpiUserPassword :: Lens' ConfigureAccessPoint (Maybe Text) Source #

The CPI password associated with the CPI certificate in cpiSecretKey.

configureAccessPoint_cpiUsername :: Lens' ConfigureAccessPoint (Maybe Text) Source #

The CPI user name of the CPI user who is certifying the coordinates of the radio unit.

configureAccessPoint_position :: Lens' ConfigureAccessPoint (Maybe Position) Source #

The position of the network resource.

configureAccessPoint_accessPointArn :: Lens' ConfigureAccessPoint Text Source #

The Amazon Resource Name (ARN) of the network resource.

Destructuring the Response

data ConfigureAccessPointResponse Source #

See: newConfigureAccessPointResponse smart constructor.

Constructors

ConfigureAccessPointResponse'
Fields httpStatus :: Int The response's http status code. accessPoint :: NetworkResource Information about the network resource.

Instances

Instances details

Generic ConfigureAccessPointResponse Source #
Instance details Defined in Amazonka.PrivateNetworks.ConfigureAccessPoint Associated Types type Rep ConfigureAccessPointResponse :: Type -> Type # Methods from :: ConfigureAccessPointResponse -> Rep ConfigureAccessPointResponse x # to :: Rep ConfigureAccessPointResponse x -> ConfigureAccessPointResponse #
Read ConfigureAccessPointResponse Source #
Instance details Defined in Amazonka.PrivateNetworks.ConfigureAccessPoint Methods readsPrec :: Int -> ReadS ConfigureAccessPointResponse # readList :: ReadS [ConfigureAccessPointResponse] # readPrec :: ReadPrec ConfigureAccessPointResponse # readListPrec :: ReadPrec [ConfigureAccessPointResponse] #
Show ConfigureAccessPointResponse Source #
Instance details Defined in Amazonka.PrivateNetworks.ConfigureAccessPoint Methods showsPrec :: Int -> ConfigureAccessPointResponse -> ShowS # show :: ConfigureAccessPointResponse -> String # showList :: [ConfigureAccessPointResponse] -> ShowS #
NFData ConfigureAccessPointResponse Source #
Instance details Defined in Amazonka.PrivateNetworks.ConfigureAccessPoint Methods rnf :: ConfigureAccessPointResponse -> () #
Eq ConfigureAccessPointResponse Source #
Instance details Defined in Amazonka.PrivateNetworks.ConfigureAccessPoint Methods (==) :: ConfigureAccessPointResponse -> ConfigureAccessPointResponse -> Bool # (/=) :: ConfigureAccessPointResponse -> ConfigureAccessPointResponse -> Bool #
type Rep ConfigureAccessPointResponse Source #
Instance details Defined in Amazonka.PrivateNetworks.ConfigureAccessPoint type Rep ConfigureAccessPointResponse = D1 ('MetaData "ConfigureAccessPointResponse" "Amazonka.PrivateNetworks.ConfigureAccessPoint" "amazonka-privatenetworks-2.0-6kTUHQMy1b1JCa08Y5Egzo" 'False) (C1 ('MetaCons "ConfigureAccessPointResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "accessPoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 NetworkResource)))

newConfigureAccessPointResponse Source #

Arguments

:: Int	`$sel:httpStatus:ConfigureAccessPointResponse'`
-> NetworkResource	`$sel:accessPoint:ConfigureAccessPointResponse'`
-> ConfigureAccessPointResponse

Create a value of ConfigureAccessPointResponse 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:ConfigureAccessPointResponse', configureAccessPointResponse_httpStatus - The response's http status code.

$sel:accessPoint:ConfigureAccessPointResponse', configureAccessPointResponse_accessPoint - Information about the network resource.

Response Lenses

configureAccessPointResponse_httpStatus :: Lens' ConfigureAccessPointResponse Int Source #

The response's http status code.

configureAccessPointResponse_accessPoint :: Lens' ConfigureAccessPointResponse NetworkResource Source #

Information about the network resource.