Skip to main content

Describe a PrefixList​

Return the prefix list associated with a rulestack.

Path Parameters
  • rulestackname string required

    The name of the rulestack.

  • name string required

    The name of the prefix list.

Request Body
  • Candidate Candidate

    Default value: true

    Prefix list candidate.

  • MaxResults Maxresults

    Default value: 100

    The maximum number of Prefix lists that you want NGFW to return for this request.

  • NextToken Nexttoken

    Possible values: non-empty and <= 2048 characters, Value must match regular expression ^[-0-9A-Za-z:\/+=]+$

    If the number of Prefix lists available for retrieval exceeds the maximum you requested, NGFW returns a NextToken value in response. To retrieve the next batch of Prefix list, use this token in your next request.

  • Running Running

    Default value: false

    Prefix list in run state.

Responses

OK

Schema
  • Response object

    The API call response.

  • Name Name

    Name of the prefix list entry.

  • NextToken Nexttoken

    Possible values: non-empty and <= 2048 characters, Value must match regular expression ^[-0-9A-Za-z:\/+=]+$

    If the number of prefix lists available for retrieval exceeds the maximum you requested, NGFW returns a NextToken value in response. To retrieve the next batch of prefix lists, use this token in your next request.

  • PrefixListCandidate object

    The prefix list candidate.

  • AuditComment Auditcomment

    Audit remarks.

  • Description Description

    The prefix list description.

  • PrefixList string[] required

    The prefix list.

  • UpdateToken Updatetoken

    Default value: 1

    Refresh token.

  • PrefixListRunning object

    The prefix lists on run state.

  • AuditComment Auditcomment

    Audit remarks.

  • Description Description

    The prefix list description.

  • PrefixList string[] required

    The prefix list.

  • UpdateToken Updatetoken

    Default value: 1

    Refresh token.

  • RuleStackName Rulestackname

    Name of the rulestack.

  • ResponseStatus object

    The API call response status.

  • ErrorCode Errorcode

    Default value: 0

    Default value of a successful response is 0. Any other number indicates an error code.

    400—HTTP bad request

    • InvalidRequestException—Operation failed due to invalid request. For example, unsupported parameter name or value in the request.
    • LimitExceededException—Operation failed due to violation in limit settings.
    • ThrottlingException—Operation failed due to throttling limitations.
    • AccessDeniedException—You do not have sufficient access to perform this action.

    500—Bad request

    • InternalServerError—Your request is valid but Cloud NGFW could not perform the operation due to a system issue.
    • InsufficientCapacityException—AWS currently does not have enough capacity to fulfill your request.
  • Reason Reason

    The error description.

Loading...