describe-networking-flex-cost-allocation-policies¶

Description¶

Describes one or more of your flex cost allocation policies. We recommend using pagination to ensure that the operation returns quickly and successfully.

Synopsis¶

  describe-networking-flex-cost-allocation-policies
[--fca-policy-ids <value>]
[--filters <value>]
[--dry-run | --no-dry-run]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]

Options¶

--fca-policy-ids (list)

The IDs of the flex cost allocation policies to describe.

Constraints:

min: 1

max: 1000

(string)

Constraints:

min: 22

max: 22

pattern: fcap-[a-f0-9]{17}

Syntax:

"string" "string" ...

--filters (list)

The filters.

fca-policy-id - The ID of the policy.

managed-by - The entity that manages the policy (account | declarative-policy ).

network-resource-type - The type of network resource that the policy applies to (natgw | ec2 | pcx ).

showback-enabled - Indicates whether showback reporting is enabled for the policy (true | false ).

(structure)

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

If you specify multiple filters, the filters are joined with an AND , and the request returns only results that match all of the specified filters.

For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide .

Name -> (string)

The name of the filter. Filter names are case-sensitive.

Values -> (list)

The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR , and the request returns all results that match any of the specified values.

(string)

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--dry-run | --no-dry-run (boolean)

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

Constraints:

min: 5

max: 1000

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream
off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

--help (boolean)

Display help for the command/subcommand.

Output¶

FlexCostAllocationPolicies -> (list)

Information about the flex cost allocation policies.

(structure)

Describes a flex cost allocation policy.

FcaPolicyId -> (string)

The ID of the policy.

Constraints:

min: 22

max: 22

pattern: fcap-[a-f0-9]{17}

FcaPolicyArn -> (string)

The Amazon Resource Name (ARN) of the policy.

Constraints:

min: 1

max: 1024

NetworkResourceType -> (string)

The type of network resource that the policy applies to.

Possible values:

natgw

pcx

ec2

NatFcaPolicyDocument -> (structure)

The policy document that defines cost allocation for NAT gateways.

ReportingGranularity -> (list) [required]

The resource granularity level at which networking costs are allocated. This parameter is required. Specify exactly one value. Valid values are eni , ec2 , subnet , vpc , account , and cidr .

Constraints:

min: 1

max: 1

(string)

The resource granularity level at which networking costs are allocated. Valid values are eni , ec2 , subnet , vpc , account , peering-id , and cidr .

Which values you can use depends on the policy document. peering-id is valid only in a PcxFcaPolicyDocument .

Possible values:

eni

ec2

subnet

vpc

account

peering-id

cidr

Dimensions -> (list) [required]

The cost dimensions to report. This parameter is required. Valid values are data-transfer and data-processing .

Constraints:

min: 1

max: 2

(string)

A cost dimension used for allocation. Valid values are data-transfer and data-processing . data-processing is valid only in a NatFcaPolicyDocument .

Possible values:

data-transfer

data-processing

CidrRangeSpecifications -> (structure)

The CIDR range mappings to use for cost allocation. Specify this value when ReportingGranularity is cidr , and omit it otherwise.

PrefixesType -> (string) [required]

The type of prefixes to use. This parameter is required. Valid values are source-prefixes and destination-prefixes .

Constraints:

min: 1

max: 64

Prefixes -> (list) [required]

The CIDR range to label mappings. You can specify from 1 to 100 mappings. This parameter is required.

Constraints:

min: 1

max: 100

(structure)

Maps a CIDR range to a label for cost allocation reporting.

CidrRange -> (string) [required]

The CIDR range. This parameter is required.

Constraints:

min: 1

max: 43

CidrLabel -> (string) [required]

The label to assign to the CIDR range. The label can be up to 64 characters long. It can contain letters, numbers, hyphens (- ), and underscores (_ ), and must start with a letter or a number. This parameter is required.

Constraints:

min: 1

max: 64

pattern: [a-zA-Z0-9][a-zA-Z0-9_\-]{0,63}

InstanceFcaPolicyDocument -> (structure)

The policy document that defines cost allocation for EC2 instances.

ReportingGranularity -> (list) [required]

The resource granularity level at which networking costs are allocated. This parameter is required. Specify exactly one value. Valid values are eni , ec2 , subnet , vpc , account , and cidr .

Constraints:

min: 1

max: 1

(string)

The resource granularity level at which networking costs are allocated. Valid values are eni , ec2 , subnet , vpc , account , peering-id , and cidr .

Which values you can use depends on the policy document. peering-id is valid only in a PcxFcaPolicyDocument .

Possible values:

eni

ec2

subnet

vpc

account

peering-id

cidr

Dimensions -> (list) [required]

The cost dimensions to report. This parameter is required. The only valid value is data-transfer .

Constraints:

min: 1

max: 2

(string)

A cost dimension used for allocation. Valid values are data-transfer and data-processing . data-processing is valid only in a NatFcaPolicyDocument .

Possible values:

data-transfer

data-processing

CidrRangeSpecifications -> (structure)

The CIDR range mappings to use for cost allocation. Specify this value when ReportingGranularity is cidr , and omit it otherwise.

PrefixesType -> (string) [required]

The type of prefixes to use. This parameter is required. Valid values are source-prefixes and destination-prefixes .

Constraints:

min: 1

max: 64

Prefixes -> (list) [required]

The CIDR range to label mappings. You can specify from 1 to 100 mappings. This parameter is required.

Constraints:

min: 1

max: 100

(structure)

Maps a CIDR range to a label for cost allocation reporting.

CidrRange -> (string) [required]

The CIDR range. This parameter is required.

Constraints:

min: 1

max: 43

CidrLabel -> (string) [required]

The label to assign to the CIDR range. The label can be up to 64 characters long. It can contain letters, numbers, hyphens (- ), and underscores (_ ), and must start with a letter or a number. This parameter is required.

Constraints:

min: 1

max: 64

pattern: [a-zA-Z0-9][a-zA-Z0-9_\-]{0,63}

PcxFcaPolicyDocument -> (structure)

The policy document that defines cost allocation for Amazon VPC peering connections.

ReportingGranularity -> (list) [required]

The resource granularity level at which networking costs are allocated. This parameter is required. Specify exactly one value. Valid values are eni , ec2 , subnet , vpc , account , peering-id , and cidr .

Constraints:

min: 1

max: 1

(string)

The resource granularity level at which networking costs are allocated. Valid values are eni , ec2 , subnet , vpc , account , peering-id , and cidr .

Which values you can use depends on the policy document. peering-id is valid only in a PcxFcaPolicyDocument .

Possible values:

eni

ec2

subnet

vpc

account

peering-id

cidr

Dimensions -> (list) [required]

The cost dimensions to report. This parameter is required. The only valid value is data-transfer .

Constraints:

min: 1

max: 2

(string)

A cost dimension used for allocation. Valid values are data-transfer and data-processing . data-processing is valid only in a NatFcaPolicyDocument .

Possible values:

data-transfer

data-processing

CidrRangeSpecifications -> (structure)

The CIDR range mappings to use for cost allocation. Specify this value when ReportingGranularity is cidr , and omit it otherwise.

PrefixesType -> (string) [required]

The type of prefixes to use. This parameter is required. Valid values are source-prefixes and destination-prefixes .

Constraints:

min: 1

max: 64

Prefixes -> (list) [required]

The CIDR range to label mappings. You can specify from 1 to 100 mappings. This parameter is required.

Constraints:

min: 1

max: 100

(structure)

Maps a CIDR range to a label for cost allocation reporting.

CidrRange -> (string) [required]

The CIDR range. This parameter is required.

Constraints:

min: 1

max: 43

CidrLabel -> (string) [required]

The label to assign to the CIDR range. The label can be up to 64 characters long. It can contain letters, numbers, hyphens (- ), and underscores (_ ), and must start with a letter or a number. This parameter is required.

Constraints:

min: 1

max: 64

pattern: [a-zA-Z0-9][a-zA-Z0-9_\-]{0,63}

ShowBackEnabled -> (boolean)

Indicates whether showback reporting is enabled for the policy.

OwnerAccount -> (string)

The ID of the account that owns the policy.

Description -> (string)

The description of the policy.

LatestVersion -> (integer)

The number of the latest version of the policy.

Constraints:

min: 1

max: 2147483647

VersionExpectedEffectiveAt -> (timestamp)

The date and time when the latest version of the policy is expected to apply to network traffic. The policy configuration in this response is from the latest version.

PolicyCreatedAt -> (timestamp)

The date and time when the policy was created.

UpdatedAt -> (timestamp)

The date and time when the policy was last updated.

ManagedBy -> (string)

The entity that manages the policy. Valid values are:

account - The account that owns the policy created it.

declarative-policy - An Amazon Web Services Organizations declarative policy created the policy. You can’t modify or delete the policy.

Possible values:

account

declarative-policy

Tags -> (list)

The tags assigned to the policy.

(structure)

Describes a tag.

Key -> (string)

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

Value -> (string)

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

NextToken -> (string)

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Table of Contents

Feedback

User Guide