Skip to content

Get Core Network Policy

networkmanager_get_core_network_policy R Documentation

Returns details about a core network policy

Description

Returns details about a core network policy. You can get details about your current live policy or any previous policy version.

Usage

networkmanager_get_core_network_policy(CoreNetworkId, PolicyVersionId,
  Alias)

Arguments

CoreNetworkId

[required] The ID of a core network.

PolicyVersionId

The ID of a core network policy version.

Alias

The alias of a core network policy

Value

A list with the following syntax:

list(
  CoreNetworkPolicy = list(
    CoreNetworkId = "string",
    PolicyVersionId = 123,
    Alias = "LIVE"|"LATEST",
    Description = "string",
    CreatedAt = as.POSIXct(
      "2015-01-01"
    ),
    ChangeSetState = "PENDING_GENERATION"|"FAILED_GENERATION"|"READY_TO_EXECUTE"|"EXECUTING"|"EXECUTION_SUCCEEDED"|"OUT_OF_DATE",
    PolicyErrors = list(
      list(
        ErrorCode = "string",
        Message = "string",
        Path = "string"
      )
    ),
    PolicyDocument = "string"
  )
)

Request syntax

svc$get_core_network_policy(
  CoreNetworkId = "string",
  PolicyVersionId = 123,
  Alias = "LIVE"|"LATEST"
)