Amazonka.OpsWorksCM.DescribeServers

Lists all configuration management servers that are identified with your account. Only the stored results from Amazon DynamoDB are returned. AWS OpsWorks CM does not query other services.

This operation is synchronous.

A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

This operation returns paginated results.

Creating a Request

data DescribeServers

See: newDescribeServers smart constructor.

Constructors

DescribeServers'

Fields

• maxResults :: Maybe Natural

  This is not currently implemented for DescribeServers requests.

• nextToken :: Maybe Text

  This is not currently implemented for DescribeServers requests.

• serverName :: Maybe Text

  Describes the server with the specified ServerName.

Instances

ToJSON DescribeServers

Defined in Amazonka.OpsWorksCM.DescribeServers

Methods

toJSON :: DescribeServers -> Value

toEncoding :: DescribeServers -> Encoding

toJSONList :: [DescribeServers] -> Value

toEncodingList :: [DescribeServers] -> Encoding

ToHeaders DescribeServers

Defined in Amazonka.OpsWorksCM.DescribeServers

Methods

toHeaders :: DescribeServers -> [Header]

ToPath DescribeServers

Defined in Amazonka.OpsWorksCM.DescribeServers

Methods

toPath :: DescribeServers -> ByteString

ToQuery DescribeServers

Defined in Amazonka.OpsWorksCM.DescribeServers

Methods

toQuery :: DescribeServers -> QueryString

AWSPager DescribeServers

Defined in Amazonka.OpsWorksCM.DescribeServers

Methods

page :: DescribeServers -> AWSResponse DescribeServers -> Maybe DescribeServers

AWSRequest DescribeServers

Defined in Amazonka.OpsWorksCM.DescribeServers

Associated Types

type AWSResponse DescribeServers

Methods

request :: (Service -> Service) -> DescribeServers -> Request DescribeServers

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeServers -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeServers)))

Generic DescribeServers

Defined in Amazonka.OpsWorksCM.DescribeServers

Associated Types

type Rep DescribeServers :: Type -> Type

Methods

from :: DescribeServers -> Rep DescribeServers x

to :: Rep DescribeServers x -> DescribeServers

Read DescribeServers

Defined in Amazonka.OpsWorksCM.DescribeServers

Methods

readsPrec :: Int -> ReadS DescribeServers

readList :: ReadS [DescribeServers]

readPrec :: ReadPrec DescribeServers

readListPrec :: ReadPrec [DescribeServers]

Show DescribeServers

Defined in Amazonka.OpsWorksCM.DescribeServers

Methods

showsPrec :: Int -> DescribeServers -> ShowS

show :: DescribeServers -> String

showList :: [DescribeServers] -> ShowS

NFData DescribeServers

Defined in Amazonka.OpsWorksCM.DescribeServers

Methods

rnf :: DescribeServers -> ()

Eq DescribeServers

Defined in Amazonka.OpsWorksCM.DescribeServers

Methods

(==) :: DescribeServers -> DescribeServers -> Bool

(/=) :: DescribeServers -> DescribeServers -> Bool

Hashable DescribeServers

Defined in Amazonka.OpsWorksCM.DescribeServers

Methods

hashWithSalt :: Int -> DescribeServers -> Int

hash :: DescribeServers -> Int

type AWSResponse DescribeServers

Defined in Amazonka.OpsWorksCM.DescribeServers

type AWSResponse DescribeServers = DescribeServersResponse

type Rep DescribeServers

Defined in Amazonka.OpsWorksCM.DescribeServers

type Rep DescribeServers = D1 ('MetaData "DescribeServers" "Amazonka.OpsWorksCM.DescribeServers" "amazonka-opsworks-cm-2.0-4eRKS676FdFBzYMnhnI9o" 'False) (C1 ('MetaCons "DescribeServers'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "serverName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDescribeServers :: DescribeServers

Create a value of DescribeServers 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:maxResults:DescribeServers', describeServers_maxResults - This is not currently implemented for DescribeServers requests.

DescribeServers, describeServers_nextToken - This is not currently implemented for DescribeServers requests.

DescribeServers, describeServers_serverName - Describes the server with the specified ServerName.

Request Lenses

describeServers_maxResults :: Lens' DescribeServers (Maybe Natural)

This is not currently implemented for DescribeServers requests.

describeServers_nextToken :: Lens' DescribeServers (Maybe Text)

This is not currently implemented for DescribeServers requests.

describeServers_serverName :: Lens' DescribeServers (Maybe Text)

Describes the server with the specified ServerName.

Destructuring the Response

data DescribeServersResponse

See: newDescribeServersResponse smart constructor.

Constructors

DescribeServersResponse'

Fields

• nextToken :: Maybe Text

  This is not currently implemented for DescribeServers requests.

• servers :: Maybe [Server]

  Contains the response to a DescribeServers request.

  For Chef Automate servers: If DescribeServersResponse$Servers$EngineAttributes includes CHEF_MAJOR_UPGRADE_AVAILABLE, you can upgrade the Chef Automate server to Chef Automate 2. To be eligible for upgrade, a server running Chef Automate 1 must have had at least one successful maintenance run after November 1, 2019.

  For Puppet servers: DescribeServersResponse$Servers$EngineAttributes contains the following two responses:

  • PUPPET_API_CA_CERT, the PEM-encoded CA certificate that is used by the Puppet API over TCP port number 8140. The CA certificate is also used to sign node certificates.
  • PUPPET_API_CRL, a certificate revocation list. The certificate revocation list is for internal maintenance purposes only. For more information about the Puppet certificate revocation list, see Man Page: puppet certificate_revocation_list in the Puppet documentation.
• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeServersResponse

Defined in Amazonka.OpsWorksCM.DescribeServers

Associated Types

type Rep DescribeServersResponse :: Type -> Type

Methods

from :: DescribeServersResponse -> Rep DescribeServersResponse x

to :: Rep DescribeServersResponse x -> DescribeServersResponse

Show DescribeServersResponse

Defined in Amazonka.OpsWorksCM.DescribeServers

Methods

showsPrec :: Int -> DescribeServersResponse -> ShowS

show :: DescribeServersResponse -> String

showList :: [DescribeServersResponse] -> ShowS

NFData DescribeServersResponse

Defined in Amazonka.OpsWorksCM.DescribeServers

Methods

rnf :: DescribeServersResponse -> ()

Eq DescribeServersResponse

Defined in Amazonka.OpsWorksCM.DescribeServers

Methods

(==) :: DescribeServersResponse -> DescribeServersResponse -> Bool

(/=) :: DescribeServersResponse -> DescribeServersResponse -> Bool

type Rep DescribeServersResponse

Defined in Amazonka.OpsWorksCM.DescribeServers

type Rep DescribeServersResponse = D1 ('MetaData "DescribeServersResponse" "Amazonka.OpsWorksCM.DescribeServers" "amazonka-opsworks-cm-2.0-4eRKS676FdFBzYMnhnI9o" 'False) (C1 ('MetaCons "DescribeServersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "servers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Server])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeServersResponse

Arguments

:: Int

$sel:httpStatus:DescribeServersResponse'

-> DescribeServersResponse

Create a value of DescribeServersResponse 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:

DescribeServers, describeServersResponse_nextToken - This is not currently implemented for DescribeServers requests.

$sel:servers:DescribeServersResponse', describeServersResponse_servers - Contains the response to a DescribeServers request.

For Chef Automate servers: If DescribeServersResponse$Servers$EngineAttributes includes CHEF_MAJOR_UPGRADE_AVAILABLE, you can upgrade the Chef Automate server to Chef Automate 2. To be eligible for upgrade, a server running Chef Automate 1 must have had at least one successful maintenance run after November 1, 2019.

For Puppet servers: DescribeServersResponse$Servers$EngineAttributes contains the following two responses:

• PUPPET_API_CA_CERT, the PEM-encoded CA certificate that is used by the Puppet API over TCP port number 8140. The CA certificate is also used to sign node certificates.
• PUPPET_API_CRL, a certificate revocation list. The certificate revocation list is for internal maintenance purposes only. For more information about the Puppet certificate revocation list, see Man Page: puppet certificate_revocation_list in the Puppet documentation.

$sel:httpStatus:DescribeServersResponse', describeServersResponse_httpStatus - The response's http status code.

Response Lenses

describeServersResponse_nextToken :: Lens' DescribeServersResponse (Maybe Text)

This is not currently implemented for DescribeServers requests.

describeServersResponse_servers :: Lens' DescribeServersResponse (Maybe [Server])

Contains the response to a DescribeServers request.

For Chef Automate servers: If DescribeServersResponse$Servers$EngineAttributes includes CHEF_MAJOR_UPGRADE_AVAILABLE, you can upgrade the Chef Automate server to Chef Automate 2. To be eligible for upgrade, a server running Chef Automate 1 must have had at least one successful maintenance run after November 1, 2019.

For Puppet servers: DescribeServersResponse$Servers$EngineAttributes contains the following two responses:

• PUPPET_API_CA_CERT, the PEM-encoded CA certificate that is used by the Puppet API over TCP port number 8140. The CA certificate is also used to sign node certificates.
• PUPPET_API_CRL, a certificate revocation list. The certificate revocation list is for internal maintenance purposes only. For more information about the Puppet certificate revocation list, see Man Page: puppet certificate_revocation_list in the Puppet documentation.

describeServersResponse_httpStatus :: Lens' DescribeServersResponse Int

The response's http status code.