aws-sdk/clients/marketplacecatalog.d.ts

import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config';
interface Blob {}
declare class MarketplaceCatalog extends Service {
  /**
   * Constructs a service object. This object has one method for each API operation.
   */
  constructor(options?: MarketplaceCatalog.Types.ClientConfiguration)
  config: Config & MarketplaceCatalog.Types.ClientConfiguration;
  /**
   * Used to cancel an open change request. Must be sent before the status of the request changes to APPLYING, the final stage of completing your change request. You can describe a change during the 60-day request history retention period for API calls.
   */
  cancelChangeSet(params: MarketplaceCatalog.Types.CancelChangeSetRequest, callback?: (err: AWSError, data: MarketplaceCatalog.Types.CancelChangeSetResponse) => void): Request<MarketplaceCatalog.Types.CancelChangeSetResponse, AWSError>;
  /**
   * Used to cancel an open change request. Must be sent before the status of the request changes to APPLYING, the final stage of completing your change request. You can describe a change during the 60-day request history retention period for API calls.
   */
  cancelChangeSet(callback?: (err: AWSError, data: MarketplaceCatalog.Types.CancelChangeSetResponse) => void): Request<MarketplaceCatalog.Types.CancelChangeSetResponse, AWSError>;
  /**
   * Provides information about a given change set.
   */
  describeChangeSet(params: MarketplaceCatalog.Types.DescribeChangeSetRequest, callback?: (err: AWSError, data: MarketplaceCatalog.Types.DescribeChangeSetResponse) => void): Request<MarketplaceCatalog.Types.DescribeChangeSetResponse, AWSError>;
  /**
   * Provides information about a given change set.
   */
  describeChangeSet(callback?: (err: AWSError, data: MarketplaceCatalog.Types.DescribeChangeSetResponse) => void): Request<MarketplaceCatalog.Types.DescribeChangeSetResponse, AWSError>;
  /**
   * Returns the metadata and content of the entity.
   */
  describeEntity(params: MarketplaceCatalog.Types.DescribeEntityRequest, callback?: (err: AWSError, data: MarketplaceCatalog.Types.DescribeEntityResponse) => void): Request<MarketplaceCatalog.Types.DescribeEntityResponse, AWSError>;
  /**
   * Returns the metadata and content of the entity.
   */
  describeEntity(callback?: (err: AWSError, data: MarketplaceCatalog.Types.DescribeEntityResponse) => void): Request<MarketplaceCatalog.Types.DescribeEntityResponse, AWSError>;
  /**
   * Returns the list of change sets owned by the account being used to make the call. You can filter this list by providing any combination of entityId, ChangeSetName, and status. If you provide more than one filter, the API operation applies a logical AND between the filters. You can describe a change during the 60-day request history retention period for API calls.
   */
  listChangeSets(params: MarketplaceCatalog.Types.ListChangeSetsRequest, callback?: (err: AWSError, data: MarketplaceCatalog.Types.ListChangeSetsResponse) => void): Request<MarketplaceCatalog.Types.ListChangeSetsResponse, AWSError>;
  /**
   * Returns the list of change sets owned by the account being used to make the call. You can filter this list by providing any combination of entityId, ChangeSetName, and status. If you provide more than one filter, the API operation applies a logical AND between the filters. You can describe a change during the 60-day request history retention period for API calls.
   */
  listChangeSets(callback?: (err: AWSError, data: MarketplaceCatalog.Types.ListChangeSetsResponse) => void): Request<MarketplaceCatalog.Types.ListChangeSetsResponse, AWSError>;
  /**
   * Provides the list of entities of a given type.
   */
  listEntities(params: MarketplaceCatalog.Types.ListEntitiesRequest, callback?: (err: AWSError, data: MarketplaceCatalog.Types.ListEntitiesResponse) => void): Request<MarketplaceCatalog.Types.ListEntitiesResponse, AWSError>;
  /**
   * Provides the list of entities of a given type.
   */
  listEntities(callback?: (err: AWSError, data: MarketplaceCatalog.Types.ListEntitiesResponse) => void): Request<MarketplaceCatalog.Types.ListEntitiesResponse, AWSError>;
  /**
   * This operation allows you to request changes in your entities.
   */
  startChangeSet(params: MarketplaceCatalog.Types.StartChangeSetRequest, callback?: (err: AWSError, data: MarketplaceCatalog.Types.StartChangeSetResponse) => void): Request<MarketplaceCatalog.Types.StartChangeSetResponse, AWSError>;
  /**
   * This operation allows you to request changes in your entities.
   */
  startChangeSet(callback?: (err: AWSError, data: MarketplaceCatalog.Types.StartChangeSetResponse) => void): Request<MarketplaceCatalog.Types.StartChangeSetResponse, AWSError>;
}
declare namespace MarketplaceCatalog {
  export type ARN = string;
  export interface CancelChangeSetRequest {
    /**
     * Required. The catalog related to the request. Fixed value: AWSMarketplace.
     */
    Catalog: Catalog;
    /**
     * Required. The unique identifier of the StartChangeSet request that you want to cancel.
     */
    ChangeSetId: ResourceId;
  }
  export interface CancelChangeSetResponse {
    /**
     * The unique identifier for the change set referenced in this request.
     */
    ChangeSetId?: ResourceId;
    /**
     * The ARN associated with the change set referenced in this request.
     */
    ChangeSetArn?: ARN;
  }
  export type Catalog = string;
  export interface Change {
    /**
     * Change types are single string values that describe your intention for the change. Each change type is unique for each EntityType provided in the change's scope.
     */
    ChangeType: ChangeType;
    /**
     * The entity to be changed.
     */
    Entity: Entity;
    /**
     * This object contains details specific to the change type of the requested change.
     */
    Details: Json;
  }
  export type ChangeSetDescription = ChangeSummary[];
  export type ChangeSetName = string;
  export type ChangeSetSummaryList = ChangeSetSummaryListItem[];
  export interface ChangeSetSummaryListItem {
    /**
     * The unique identifier for a change set.
     */
    ChangeSetId?: ResourceId;
    /**
     * The ARN associated with the unique identifier for the change set referenced in this request.
     */
    ChangeSetArn?: ARN;
    /**
     * The non-unique name for the change set.
     */
    ChangeSetName?: ChangeSetName;
    /**
     * The time, in ISO 8601 format (2018-02-27T13:45:22Z), when the change set was started.
     */
    StartTime?: DateTimeISO8601;
    /**
     * The time, in ISO 8601 format (2018-02-27T13:45:22Z), when the change set was finished.
     */
    EndTime?: DateTimeISO8601;
    /**
     * The current status of the change set.
     */
    Status?: ChangeStatus;
    /**
     * This object is a list of entity IDs (string) that are a part of a change set. The entity ID list is a maximum of 20 entities. It must contain at least one entity.
     */
    EntityIdList?: ResourceIdList;
  }
  export type ChangeStatus = "PREPARING"|"APPLYING"|"SUCCEEDED"|"CANCELLED"|"FAILED"|string;
  export interface ChangeSummary {
    /**
     * The type of the change.
     */
    ChangeType?: ChangeType;
    /**
     * The entity to be changed.
     */
    Entity?: Entity;
    /**
     * An array of ErrorDetail objects associated with the change.
     */
    ErrorDetailList?: ErrorDetailList;
  }
  export type ChangeType = string;
  export type ClientRequestToken = string;
  export type DateTimeISO8601 = string;
  export interface DescribeChangeSetRequest {
    /**
     * Required. The catalog related to the request. Fixed value: AWSMarketplace 
     */
    Catalog: Catalog;
    /**
     * Required. The unique identifier for the StartChangeSet request that you want to describe the details for.
     */
    ChangeSetId: ResourceId;
  }
  export interface DescribeChangeSetResponse {
    /**
     * Required. The unique identifier for the change set referenced in this request.
     */
    ChangeSetId?: ResourceId;
    /**
     * The ARN associated with the unique identifier for the change set referenced in this request.
     */
    ChangeSetArn?: ARN;
    /**
     * The optional name provided in the StartChangeSet request. If you do not provide a name, one is set by default.
     */
    ChangeSetName?: ChangeSetName;
    /**
     * The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request started. 
     */
    StartTime?: DateTimeISO8601;
    /**
     * The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request transitioned to a terminal state. The change cannot transition to a different state. Null if the request is not in a terminal state. 
     */
    EndTime?: DateTimeISO8601;
    /**
     * The status of the change request.
     */
    Status?: ChangeStatus;
    /**
     * Returned if there is a failure on the change set, but that failure is not related to any of the changes in the request.
     */
    FailureDescription?: StringValue;
    /**
     * An array of ChangeSummary objects.
     */
    ChangeSet?: ChangeSetDescription;
  }
  export interface DescribeEntityRequest {
    /**
     * Required. The catalog related to the request. Fixed value: AWSMarketplace 
     */
    Catalog: Catalog;
    /**
     * Required. The unique ID of the entity to describe.
     */
    EntityId: ResourceId;
  }
  export interface DescribeEntityResponse {
    /**
     * The named type of the entity, in the format of EntityType@Version.
     */
    EntityType?: EntityType;
    /**
     * The identifier of the entity, in the format of EntityId@RevisionId.
     */
    EntityIdentifier?: Identifier;
    /**
     * The ARN associated to the unique identifier for the change set referenced in this request.
     */
    EntityArn?: ARN;
    /**
     * The last modified date of the entity, in ISO 8601 format (2018-02-27T13:45:22Z).
     */
    LastModifiedDate?: StringValue;
    /**
     * This stringified JSON object includes the details of the entity.
     */
    Details?: Json;
  }
  export interface Entity {
    /**
     * The type of entity.
     */
    Type: EntityType;
    /**
     * The identifier for the entity.
     */
    Identifier?: Identifier;
  }
  export interface EntitySummary {
    /**
     * The name for the entity. This value is not unique. It is defined by the provider.
     */
    Name?: StringValue;
    /**
     * The type of the entity.
     */
    EntityType?: EntityType;
    /**
     * The unique identifier for the entity.
     */
    EntityId?: ResourceId;
    /**
     * The ARN associated with the unique identifier for the entity.
     */
    EntityArn?: ARN;
    /**
     * The last time the entity was published, using ISO 8601 format (2018-02-27T13:45:22Z).
     */
    LastModifiedDate?: StringValue;
    /**
     * The visibility status of the entity to subscribers. This value can be Public (everyone can view the entity), Limited (the entity is visible to limited accounts only), or Restricted (the entity was published and then unpublished and only existing subscribers can view it). 
     */
    Visibility?: StringValue;
  }
  export type EntitySummaryList = EntitySummary[];
  export type EntityType = string;
  export interface ErrorDetail {
    /**
     * The error code that identifies the type of error.
     */
    ErrorCode?: StringValue;
    /**
     * The message for the error.
     */
    ErrorMessage?: StringValue;
  }
  export type ErrorDetailList = ErrorDetail[];
  export interface Filter {
    /**
     * For ListEntities, the supported value for this is an EntityId. For ListChangeSets, the supported values are as follows:
     */
    Name?: FilterName;
    /**
     *  ListEntities - This is a list of unique EntityIds.  ListChangeSets - The supported filter names and associated ValueLists is as follows:    ChangeSetName - The supported ValueList is a list of non-unique ChangeSetNames. These are defined when you call the StartChangeSet action.    Status - The supported ValueList is a list of statuses for all change set requests.    EntityId - The supported ValueList is a list of unique EntityIds.    BeforeStartTime - The supported ValueList is a list of all change sets that started before the filter value.    AfterStartTime - The supported ValueList is a list of all change sets that started after the filter value.    BeforeEndTime - The supported ValueList is a list of all change sets that ended before the filter value.    AfterEndTime - The supported ValueList is a list of all change sets that ended after the filter value.  
     */
    ValueList?: ValueList;
  }
  export type FilterList = Filter[];
  export type FilterName = string;
  export type Identifier = string;
  export type Json = string;
  export interface ListChangeSetsRequest {
    /**
     * The catalog related to the request. Fixed value: AWSMarketplace 
     */
    Catalog: Catalog;
    /**
     * An array of filter objects.
     */
    FilterList?: FilterList;
    /**
     * An object that contains two attributes, sortBy and sortOrder.
     */
    Sort?: Sort;
    /**
     * The maximum number of results returned by a single call. This value must be provided in the next call to retrieve the next set of results. By default, this value is 20.
     */
    MaxResults?: MaxResultInteger;
    /**
     * The token value retrieved from a previous call to access the next page of results.
     */
    NextToken?: NextToken;
  }
  export interface ListChangeSetsResponse {
    /**
     *  Array of ChangeSetSummaryListItem objects.
     */
    ChangeSetSummaryList?: ChangeSetSummaryList;
    /**
     * The value of the next token, if it exists. Null if there are no more results.
     */
    NextToken?: NextToken;
  }
  export interface ListEntitiesRequest {
    /**
     * The catalog related to the request. Fixed value: AWSMarketplace 
     */
    Catalog: Catalog;
    /**
     * The type of entities to retrieve.
     */
    EntityType: EntityType;
    /**
     * An array of filter objects. Each filter object contains two attributes, filterName and filterValues.
     */
    FilterList?: FilterList;
    /**
     * An object that contains two attributes, sortBy and sortOrder.
     */
    Sort?: Sort;
    /**
     * The value of the next token, if it exists. Null if there are no more results.
     */
    NextToken?: NextToken;
    /**
     * Specifies the upper limit of the elements on a single page. If a value isn't provided, the default value is 20.
     */
    MaxResults?: MaxResultInteger;
  }
  export interface ListEntitiesResponse {
    /**
     *  Array of EntitySummary object.
     */
    EntitySummaryList?: EntitySummaryList;
    /**
     * The value of the next token if it exists. Null if there is no more result.
     */
    NextToken?: NextToken;
  }
  export type MaxResultInteger = number;
  export type NextToken = string;
  export type RequestedChangeList = Change[];
  export type ResourceId = string;
  export type ResourceIdList = ResourceId[];
  export interface Sort {
    /**
     * For ListEntities, supported attributes include LastModifiedDate (default), Visibility, EntityId, and Name. For ListChangeSets, supported attributes include StartTime and EndTime.
     */
    SortBy?: SortBy;
    /**
     * The sorting order. Can be ASCENDING or DESCENDING. The default value is DESCENDING.
     */
    SortOrder?: SortOrder;
  }
  export type SortBy = string;
  export type SortOrder = "ASCENDING"|"DESCENDING"|string;
  export interface StartChangeSetRequest {
    /**
     * The catalog related to the request. Fixed value: AWSMarketplace 
     */
    Catalog: Catalog;
    /**
     * Array of change object.
     */
    ChangeSet: RequestedChangeList;
    /**
     * Optional case sensitive string of up to 100 ASCII characters. The change set name can be used to filter the list of change sets. 
     */
    ChangeSetName?: ChangeSetName;
    /**
     * A unique token to identify the request to ensure idempotency.
     */
    ClientRequestToken?: ClientRequestToken;
  }
  export interface StartChangeSetResponse {
    /**
     * Unique identifier generated for the request.
     */
    ChangeSetId?: ResourceId;
    /**
     * The ARN associated to the unique identifier generated for the request.
     */
    ChangeSetArn?: ARN;
  }
  export type StringValue = string;
  export type ValueList = StringValue[];
  /**
   * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
   */
  export type apiVersion = "2018-09-17"|"latest"|string;
  export interface ClientApiVersions {
    /**
     * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
     */
    apiVersion?: apiVersion;
  }
  export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
  /**
   * Contains interfaces for use with the MarketplaceCatalog client.
   */
  export import Types = MarketplaceCatalog;
}
export = MarketplaceCatalog;