get-partner¶

Description¶

Retrieves detailed information about a specific partner account.

Synopsis¶

  get-partner
--catalog <value>
--identifier <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]

Options¶

--catalog (string) [required]

The catalog identifier for the partner account.

Constraints:

min: 1

max: 64

pattern: [a-zA-Z0-9-]+

--identifier (string) [required]

The unique identifier of the partner account to retrieve.

Constraints:

min: 1

max: 200

pattern: (partner-[A-Za-z0-9]{13}|arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[A-Za-z-_]+/partner/partner-[A-Za-z0-9]{13})

--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

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

Output¶

Catalog -> (string)

The catalog identifier for the partner account.

Constraints:

min: 1

max: 64

pattern: [a-zA-Z0-9-]+

Arn -> (string)

The Amazon Resource Name (ARN) of the partner account.

Constraints:

min: 1

max: 200

pattern: arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[A-Za-z-_]+/partner/partner-[A-Za-z0-9]{13}

Id -> (string)

The unique identifier of the partner account.

Constraints:

pattern: partner-[A-Za-z0-9]{13}

LegalName -> (string)

The legal name of the partner organization.

Constraints:

min: 1

max: 80

pattern: [\u0020-\u007E\u00A0-\uD7FF\uE000-\uFFFD]+

CreatedAt -> (timestamp)

The timestamp when the partner account was created.

Profile -> (structure)

The partner profile information including display name, description, and other public details.

DisplayName -> (string) [required]

The public display name for the partner organization.

Constraints:

min: 1

max: 80

pattern: [\u0020-\u007E\u00A0-\uD7FF\uE000-\uFFFD]+

Description -> (string) [required]

A description of the partner’s business, services, and capabilities.

Constraints:

min: 1

max: 600

pattern: [\u0020-\u007E\u00A0-\uD7FF\uE000-\uFFFD]+

WebsiteUrl -> (string) [required]

The partner’s primary website URL.

Constraints:

min: 1

max: 256

pattern: (https|HTTPS):\/\/[^\/\s]+(\/\S*)?

LogoUrl -> (string) [required]

The URL to the partner’s logo image.

Constraints:

min: 1

max: 256

pattern: (https|HTTPS):\/\/[^\/\s]+(\/\S*)?

PrimarySolutionType -> (string) [required]

The primary type of solution or service the partner provides.

Possible values:

SOFTWARE_PRODUCTS

CONSULTING_SERVICES

PROFESSIONAL_SERVICES

MANAGED_SERVICES

HARDWARE_PRODUCTS

COMMUNICATION_SERVICES

VALUE_ADDED_RESALE_AWS_SERVICES

TRAINING_SERVICES

IndustrySegments -> (list) [required]

The industry segments or verticals that the partner serves.

Constraints:

min: 1

max: 3

(string)

Possible values:

AGRICULTURE_MINING

BIOTECHNOLOGY

BUSINESS_CONSUMER_SERVICES

BUSINESS_SERV

COMMUNICATIONS

COMPUTER_HARDWARE

COMPUTERS_ELECTRONICS

COMPUTER_SOFTWARE

CONSUMER_GOODS

CONSUMER_RELATED

EDUCATION

ENERGY_UTILITIES

FINANCIAL_SERVICES

GAMING

GOVERNMENT

GOVERNMENT_EDUCATION_PUBLIC_SERVICES

HEALTHCARE

HEALTHCARE_PHARMACEUTICALS_BIOTECH

INDUSTRIAL_ENERGY

INTERNET_SPECIFIC

LIFE_SCIENCES

MANUFACTURING

MEDIA_ENTERTAINMENT_LEISURE

MEDIA_ENTERTAINMENT

MEDICAL_HEALTH

NON_PROFIT_ORGANIZATION

OTHER

PROFESSIONAL_SERVICES

REAL_ESTATE_CONSTRUCTION

RETAIL

RETAIL_WHOLESALE_DISTRIBUTION

SEMICONDUCTOR_ELECTR

SOFTWARE_INTERNET

TELECOMMUNICATIONS

TRANSPORTATION_LOGISTICS

TRAVEL_HOSPITALITY

WHOLESALE_DISTRIBUTION

TranslationSourceLocale -> (string) [required]

The source locale used for automatic translation of profile content.

Constraints:

pattern: [a-z]{2}-[A-Z]{2}

LocalizedContents -> (list)

A list of localized content versions for different languages and regions.

Constraints:

min: 0

max: 20

(structure)

Contains localized content for a partner profile in a specific language or locale.

DisplayName -> (string) [required]

The localized display name for the partner.

Constraints:

min: 1

max: 80

pattern: [\u0020-\u007E\u00A0-\uD7FF\uE000-\uFFFD]+

Description -> (string) [required]

The localized description of the partner’s business and services.

Constraints:

min: 1

max: 600

pattern: [\u0020-\u007E\u00A0-\uD7FF\uE000-\uFFFD]+

WebsiteUrl -> (string) [required]

The localized website URL for the partner.

Constraints:

min: 1

max: 256

pattern: (https|HTTPS):\/\/[^\/\s]+(\/\S*)?

LogoUrl -> (string) [required]

The URL to the partner’s logo image for this locale.

Constraints:

min: 1

max: 256

pattern: (https|HTTPS):\/\/[^\/\s]+(\/\S*)?

Locale -> (string) [required]

The locale or language code for the localized content.

Constraints:

pattern: [a-z]{2}-[A-Z]{2}

ProfileId -> (string)

The unique identifier of the partner profile.

Constraints:

min: 1

max: 50

pattern: pprofile-[A-Za-z0-9]{13}

AwsTrainingCertificationEmailDomains -> (list)

The list of verified email domains associated with AWS training and certification credentials for the partner organization.

Constraints:

min: 0

max: 100

(structure)

Represents a verified domain associated with a partner account.

DomainName -> (string) [required]

The domain name that has been verified for the partner account.

Constraints:

min: 1

max: 253

pattern: [a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(\.[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*

RegisteredAt -> (timestamp) [required]

The timestamp when the domain was registered and verified for the partner account.

Table of Contents

Feedback

User Guide